ONE - On-device Neural Engine
Loading...
Searching...
No Matches
ggma_types.h File Reference

This file defines the core types and status codes for GGMA API. More...

#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Typedefs

typedef struct ggma_context ggma_context
 
typedef int32_t ggma_token
 
typedef struct ggma_tokenizer ggma_tokenizer
 

Enumerations

enum  GGMA_STATUS {
  GGMA_STATUS_NO_ERROR = 0 , GGMA_STATUS_ERROR = 1 , GGMA_STATUS_UNEXPECTED_NULL = 2 , GGMA_STATUS_OUT_OF_MEMORY = 4 ,
  GGMA_STATUS_DEPRECATED_API = 6
}
 Enumeration of status codes returned by GGMA API functions. More...
 

Detailed Description

This file defines the core types and status codes for GGMA API.

Definition in file ggma_types.h.

Typedef Documentation

◆ ggma_context

typedef struct ggma_context ggma_context

Definition at line 52 of file ggma_types.h.

◆ ggma_token

typedef int32_t ggma_token

Definition at line 53 of file ggma_types.h.

◆ ggma_tokenizer

Definition at line 54 of file ggma_types.h.

Enumeration Type Documentation

◆ GGMA_STATUS

Enumeration of status codes returned by GGMA API functions.

Enumerator
GGMA_STATUS_NO_ERROR 

The operation completed successfully.

GGMA_STATUS_ERROR 

A general error occurred. This code is typically used when no more specific error code is applicable.

GGMA_STATUS_UNEXPECTED_NULL 

Unexpected null argument is given.

GGMA_STATUS_OUT_OF_MEMORY 

The system ran out of memory.

GGMA_STATUS_DEPRECATED_API 

The called API function is deprecated and should no longer be used.

Definition at line 34 of file ggma_types.h.

35{
GGMA_STATUS
Enumeration of status codes returned by GGMA API functions.
Definition ggma_types.h:35
@ GGMA_STATUS_NO_ERROR
Definition ggma_types.h:37
@ GGMA_STATUS_UNEXPECTED_NULL
Definition ggma_types.h:44
@ GGMA_STATUS_DEPRECATED_API
Definition ggma_types.h:48
@ GGMA_STATUS_ERROR
Definition ggma_types.h:42
@ GGMA_STATUS_OUT_OF_MEMORY
Definition ggma_types.h:46