File notation_tv.c

FileList > note-twist_vector > src > notation_tv.c

Go to the source code of this file

Notation module for twist vectors. More...

• #include "notation_tv.h"
• #include "stdio.h"
• #include "stdlib.h"

Public Functions

Type	Name
uint8_t	note_tv_decode (char * str, note_tv_t * twistv) Function to take a string and decode it as a note_tv_t .
uint8_t	note_tv_encode (note_tv_t twistv, char * str, size_t buffer_size) Function to take a note_tv_t and encode it as a string.
STATIC_INLINE note_tv_t *	note_tv_tvrev (note_tv_t * tv) A function to reverse the order of the twist vector.

Macros

Type	Name
define	NOTE_TV_INT_BASE (10u) The number base used for str->int functions.

Detailed Description

Author:

Isabel Darcy

Author:

Zachary Bryhtan

Author:

Joe Starr

Public Functions Documentation

function note_tv_decode

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

uint8_t note_tv_decode (
    char * str,
    note_tv_t * twistv
) 

Parameters:

• str Input string to encode as note_tv_t
• twistv the note_tv_t pointer to store the string into.

Returns:

uint8_t The return code for the encoding operation.

---

function note_tv_encode

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

uint8_t note_tv_encode (
    note_tv_t twistv,
    char * str,
    size_t buffer_size
) 

Parameters:

• twistv the note_tv_t pointer to encode.
• str Output string for encoded note_tv_t

Returns:

uint8_t The return code for the encoding operation.

---

function note_tv_tvrev

A function to reverse the order of the twist vector.

STATIC_INLINE note_tv_t * note_tv_tvrev (
    note_tv_t * tv
) 

Parameters:

• tv Twist vector to work on.

Returns:

note_tv_t a pointer to the reversed object, needed for nesting.

---

Macro Definition Documentation

define NOTE_TV_INT_BASE

The number base used for str->int functions.

#define NOTE_TV_INT_BASE `(10u)`

---

---

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