Skip to content

File notation_att.h

FileList > note-algebraic_tangle_tree > src > notation_att.h

Go to the source code of this file

Notation module for twist vector notation. More...

  • #include "notation_defs.h"
  • #include "notation_tv.h"
  • #include "stdbool.h"
  • #include "stdint.h"
  • #include "stdlib.h"
  • #include "string.h"

Classes

Type Name
struct note_att_node_t
The core structure for algebraic tangle trees.
struct note_att_t
The core structure for algebraic tangle trees.

Public Types

Type Name
typedef struct note_att_node_t note_att_node_t
The core structure for algebraic tangle trees.

Public Functions

Type Name
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.

Macros

Type Name
define NOTE_ATT_CHK_OP (FLVR, OP) (((FLVR) & (0x03u << NOTE\_ATT\_OP\_SHIFT\_LEN)) == (OP) ? (true) : (false))
define NOTE_ATT_CLR_OP (FLV) (FLV = ((FLV)&(~(0x03u << NOTE\_ATT\_OP\_SHIFT\_LEN))))
define NOTE_ATT_OP_PLUS (0x01u << NOTE\_ATT\_OP\_SHIFT\_LEN)
define NOTE_ATT_OP_SHIFT_LEN (0x00u)
define NOTE_ATT_OP_UNINIT (0x00u << NOTE\_ATT\_OP\_SHIFT\_LEN)
define NOTE_ATT_OP_VEE (0x02u << NOTE\_ATT\_OP\_SHIFT\_LEN)
define NOTE_ATT_SET_OP (FLV, OP) (FLV = (((FLV) \| (OP))))
define NOTE_ATT_TRAVERSE_FAIL (0x01u)
define NOTE_ATT_TRAVERSE_SUCCESS (0x00u)

Detailed Description

Author:

Isabel Darcy

Author:

Zachary Bryhtan

Author:

Joe Starr

Public Types Documentation

typedef note_att_node_t

The core structure for algebraic tangle trees. 

typedef struct note_att_node_t note_att_node_t;

Public Functions Documentation

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:

Returns:

uint8_t The return code for the encoding operation.

Macro Definition Documentation

define NOTE_ATT_CHK_OP

#define NOTE_ATT_CHK_OP (
    FLVR,
    OP
) `(((FLVR) & (0x03u << NOTE_ATT_OP_SHIFT_LEN)) == (OP) ? (true) : (false))`

define NOTE_ATT_CLR_OP

#define NOTE_ATT_CLR_OP (
    FLV
) `(FLV = ((FLV)&(~(0x03u << NOTE_ATT_OP_SHIFT_LEN))))`

define NOTE_ATT_OP_PLUS

#define NOTE_ATT_OP_PLUS `(0x01u << NOTE_ATT_OP_SHIFT_LEN)`

define NOTE_ATT_OP_SHIFT_LEN

#define NOTE_ATT_OP_SHIFT_LEN `(0x00u)`

define NOTE_ATT_OP_UNINIT

#define NOTE_ATT_OP_UNINIT `(0x00u << NOTE_ATT_OP_SHIFT_LEN)`

define NOTE_ATT_OP_VEE

#define NOTE_ATT_OP_VEE `(0x02u << NOTE_ATT_OP_SHIFT_LEN)`

define NOTE_ATT_SET_OP

#define NOTE_ATT_SET_OP (
    FLV,
    OP
) `(FLV = (((FLV) | (OP))))`

define NOTE_ATT_TRAVERSE_FAIL

#define NOTE_ATT_TRAVERSE_FAIL `(0x01u)`

define NOTE_ATT_TRAVERSE_SUCCESS

#define NOTE_ATT_TRAVERSE_SUCCESS `(0x00u)`

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