{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "5f3fed9f21a57390cc7f00f77a37db8f5f110cb8",
    "tool": "doxyref",
    "version": "1.17.0"
  },
  "language": "c",
  "modules": [
    {
      "description": "",
      "name": "Softmax Functions",
      "path": "heliaCORE.Softmax",
      "submodules": [],
      "summary": "",
      "symbols": [
        {
          "description": "Softmax using the float-native API signature.",
          "examples": [],
          "id": "arm_softmax_f32",
          "kind": "function",
          "language": "c",
          "members": [],
          "name": "arm_softmax_f32",
          "params": [
            {
              "description": "Pointer to the input matrix stored as `num_rows` rows of `row_size` values.",
              "direction": "in",
              "name": "input",
              "type": "const float32_t *"
            },
            {
              "description": "Number of rows in the input matrix.",
              "direction": "in",
              "name": "num_rows",
              "type": "int32_t"
            },
            {
              "description": "Number of columns per row.",
              "direction": "in",
              "name": "row_size",
              "type": "int32_t"
            },
            {
              "description": "Pointer to the output matrix.",
              "direction": "out",
              "name": "output",
              "type": "float32_t *"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "`ARM_CMSIS_NN_SUCCESS` on success or `ARM_CMSIS_NN_ARG_ERROR` on invalid arguments."
            }
          ],
          "signature": "arm_cmsis_nn_status arm_softmax_f32(const float32_t *input, int32_t num_rows, int32_t row_size, float32_t *output)",
          "source": {
            "line": 1882,
            "path": "Include/arm_nnfunctions_flt.h",
            "url": "https://github.com/AmbiqAI/ns-cmsis-nn/blob/5f3fed9f21a57390cc7f00f77a37db8f5f110cb8/Include/arm_nnfunctions_flt.h#L1882"
          },
          "summary": "Softmax using the float-native API signature."
        },
        {
          "description": "Softmax using the float-native API signature.",
          "examples": [],
          "id": "arm_softmax_f16",
          "kind": "function",
          "language": "c",
          "members": [],
          "name": "arm_softmax_f16",
          "params": [
            {
              "description": "Pointer to the input matrix stored as `num_rows` rows of `row_size` values.",
              "direction": "in",
              "name": "input",
              "type": "const float16_t *"
            },
            {
              "description": "Number of rows in the input matrix.",
              "direction": "in",
              "name": "num_rows",
              "type": "int32_t"
            },
            {
              "description": "Number of columns per row.",
              "direction": "in",
              "name": "row_size",
              "type": "int32_t"
            },
            {
              "description": "Pointer to the output matrix.",
              "direction": "out",
              "name": "output",
              "type": "float16_t *"
            }
          ],
          "raises": [],
          "returns": [
            {
              "description": "`ARM_CMSIS_NN_SUCCESS` on success or `ARM_CMSIS_NN_ARG_ERROR` on invalid arguments."
            }
          ],
          "signature": "arm_cmsis_nn_status arm_softmax_f16(const float16_t *input, int32_t num_rows, int32_t row_size, float16_t *output)",
          "source": {
            "line": 3640,
            "path": "Include/arm_nnfunctions_flt.h",
            "url": "https://github.com/AmbiqAI/ns-cmsis-nn/blob/5f3fed9f21a57390cc7f00f77a37db8f5f110cb8/Include/arm_nnfunctions_flt.h#L3640"
          },
          "summary": "Softmax using the float-native API signature."
        }
      ]
    }
  ],
  "name": "heliaCORE"
}