{
  "$schema": "https://ambiqai.github.io/helia-ui/schema/reference-model-1.json",
  "generatedFrom": {
    "sourceCommit": "70611e608778a432566e30965e8b4bc7ea75aa36",
    "tool": "doxyref",
    "version": "1.17.0"
  },
  "language": "cpp",
  "modules": [
    {
      "description": "Sequential buffer placement without reuse.",
      "name": "LinearMemoryPlanner",
      "path": "linearmemoryplanner",
      "submodules": [],
      "summary": "Sequential buffer placement without reuse.",
      "symbols": [
        {
          "description": "The simplest possible memory planner that just lays out all buffers at increasing offsets without trying to reuse memory.",
          "examples": [],
          "id": "tflite::LinearMemoryPlanner",
          "kind": "class",
          "language": "cpp",
          "members": [
            {
              "description": "",
              "examples": [],
              "id": "tflite::LinearMemoryPlanner::LinearMemoryPlanner",
              "kind": "method",
              "language": "cpp",
              "members": [],
              "name": "LinearMemoryPlanner",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "tflite::LinearMemoryPlanner::LinearMemoryPlanner()",
              "source": {
                "line": 28,
                "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
                "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L28"
              },
              "summary": ""
            },
            {
              "description": "",
              "examples": [],
              "id": "tflite::LinearMemoryPlanner::~LinearMemoryPlanner",
              "kind": "method",
              "language": "cpp",
              "members": [],
              "name": "~LinearMemoryPlanner",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "tflite::LinearMemoryPlanner::~LinearMemoryPlanner()",
              "source": {
                "line": 29,
                "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
                "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L29"
              },
              "summary": ""
            },
            {
              "description": "Pass information about a buffer's size and lifetime to the layout algorithm. The order this is called implicitly assigns an index to the result, so the buffer information that's passed into the N-th call of this method will be used as the buffer_index argument to `GetOffsetForBuffer()`.",
              "examples": [],
              "id": "tflite::LinearMemoryPlanner::AddBuffer",
              "kind": "method",
              "language": "cpp",
              "members": [],
              "name": "AddBuffer",
              "params": [
                {
                  "description": "",
                  "name": "size",
                  "type": "int"
                },
                {
                  "description": "",
                  "name": "first_time_used",
                  "type": "int"
                },
                {
                  "description": "",
                  "name": "last_time_used",
                  "type": "int"
                }
              ],
              "raises": [],
              "returns": [],
              "signature": "TfLiteStatus tflite::LinearMemoryPlanner::AddBuffer(int size, int first_time_used, int last_time_used)",
              "source": {
                "line": 31,
                "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
                "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L31"
              },
              "summary": "Pass information about a buffer's size and lifetime to the layout algorithm."
            },
            {
              "description": "The largest contiguous block of memory that's needed to hold the layout.",
              "examples": [],
              "id": "tflite::LinearMemoryPlanner::GetMaximumMemorySize",
              "kind": "method",
              "language": "cpp",
              "members": [],
              "name": "GetMaximumMemorySize",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "size_t tflite::LinearMemoryPlanner::GetMaximumMemorySize()",
              "source": {
                "line": 34,
                "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
                "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L34"
              },
              "summary": "The largest contiguous block of memory that's needed to hold the layout."
            },
            {
              "description": "How many buffers have been added to the planner.",
              "examples": [],
              "id": "tflite::LinearMemoryPlanner::GetBufferCount",
              "kind": "method",
              "language": "cpp",
              "members": [],
              "name": "GetBufferCount",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "int tflite::LinearMemoryPlanner::GetBufferCount()",
              "source": {
                "line": 35,
                "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
                "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L35"
              },
              "summary": "How many buffers have been added to the planner."
            },
            {
              "description": "Calculated layout offset for the N-th buffer added to the planner.",
              "examples": [],
              "id": "tflite::LinearMemoryPlanner::GetOffsetForBuffer",
              "kind": "method",
              "language": "cpp",
              "members": [],
              "name": "GetOffsetForBuffer",
              "params": [
                {
                  "description": "",
                  "name": "buffer_index",
                  "type": "int"
                },
                {
                  "description": "",
                  "name": "offset",
                  "type": "int *"
                }
              ],
              "raises": [],
              "returns": [],
              "signature": "TfLiteStatus tflite::LinearMemoryPlanner::GetOffsetForBuffer(int buffer_index, int *offset)",
              "source": {
                "line": 36,
                "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
                "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L36"
              },
              "summary": "Calculated layout offset for the N-th buffer added to the planner."
            },
            {
              "description": "Returns True because the `LinearMemoryPlanner` preserves all tensors after invocation.",
              "examples": [],
              "id": "tflite::LinearMemoryPlanner::preserves_all_tensors",
              "kind": "method",
              "language": "cpp",
              "members": [],
              "name": "preserves_all_tensors",
              "params": [],
              "raises": [],
              "returns": [],
              "signature": "bool tflite::LinearMemoryPlanner::preserves_all_tensors() const",
              "source": {
                "line": 40,
                "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
                "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L40"
              },
              "summary": "Returns True because the LinearMemoryPlanner preserves all tensors after invocation."
            }
          ],
          "name": "LinearMemoryPlanner",
          "params": [],
          "raises": [],
          "returns": [],
          "signature": "class LinearMemoryPlanner : public tflite::MicroMemoryPlanner",
          "source": {
            "line": 26,
            "path": "tensorflow/lite/micro/memory_planner/linear_memory_planner.h",
            "url": "https://github.com/AmbiqAI/helia-rt/blob/70611e608778a432566e30965e8b4bc7ea75aa36/tensorflow/lite/micro/memory_planner/linear_memory_planner.h#L26"
          },
          "summary": "The simplest possible memory planner that just lays out all buffers at increasing offsets without trying to reuse memory."
        }
      ]
    }
  ],
  "name": "heliaRT"
}