File notation_att.c

FileList > note-algebraic_tangle_tree > src > notation_att.c

Notation module for twist vectors. More...

#include "notation_att.h"
#include "stdio.h"
#include "stdlib.h"

Public Static Attributes

Type	Name
size_t	note_att_str_idx = `0u` store-storage_interface for the current string index.
size_t	note_att_tv_idx = `0u` store-storage_interface for the current twist vector index.

Public Functions

Type	Name
STATIC_INLINE_UINT8	note_att_add_tv (const note_tv_t * tv, char * str, size_t buffer_size) Decode a string into a twist vector and report succes.
uint8_t	note_att_decode (char * str, note_att_t * att) Function to take a string and decode it as a note_att_t .
uint8_t	note_att_encode (note_att_t att, char * str, size_t buffer_size) Function to take a note_att_t and encode it as a string.
STATIC_INLINE_UINT8	note_att_process_tv (const char * str, note_att_t * att)
STATIC_INLINE_UINT8	note_att_traverse (note_att_node_t * node, char * str, size_t buffer_size)
STATIC_INLINE_UINT8	note_att_traverse_string (note_att_t * att, note_att_node_t * node, char * str, size_t att_node_idx) Walk the string converting it to an algebraic tangle tree.

Detailed Description

Author:

Isabel Darcy

Author:

Zachary Bryhtan

Author:

Joe Starr

Public Static Attributes Documentation

variable note_att_str_idx

store-storage_interface for the current string index.

size_t note_att_str_idx;

variable note_att_tv_idx

store-storage_interface for the current twist vector index.

size_t note_att_tv_idx;

Public Functions Documentation

function note_att_add_tv

Decode a string into a twist vector and report succes.

STATIC_INLINE_UINT8 note_att_add_tv (
    const note_tv_t * tv,
    char * str,
    size_t buffer_size
)

Parameters:

tv The note_tv_t store-storage_interface to store the data to.
str The data to decode.

Returns:

Indicate success failure of adding the twist vector.

function note_att_decode

Function to take a string and decode it as a note_att_t .

uint8_t note_att_decode (
    char * str,
    note_att_t * att
)

Parameters:

str Input string to decode as note_att_t
att the note_att_t pointer to store the decoded string into.

Returns:

uint8_t The return code for the encoding operation.

function note_att_encode

Function to take a note_att_t and encode it as a string.

uint8_t note_att_encode (
    note_att_t att,
    char * str,
    size_t buffer_size
)

Parameters:

att the note_att_t pointer to encode.
str Output string for encoded note_att_t

Returns:

uint8_t The return code for the encoding operation.

function note_att_process_tv

STATIC_INLINE_UINT8 note_att_process_tv (
    const char * str,
    note_att_t * att
)

Parameters:

str
att

Returns:

function note_att_traverse

STATIC_INLINE_UINT8 note_att_traverse (
    note_att_node_t * node,
    char * str,
    size_t buffer_size
)

Parameters:

node
str

Returns:

function note_att_traverse_string

Walk the string converting it to an algebraic tangle tree.

STATIC_INLINE_UINT8 note_att_traverse_string (
    note_att_t * att,
    note_att_node_t * node,
    char * str,
    size_t att_node_idx
)

Parameters:

att The store-storage_interface location for the algebraic tangle tree.
node
str
att_node_idx

Returns:

The documentation for this class was generated from the following file source/note-algebraic_tangle_tree/src/notation_att.c