File comp_rlitt_pure_vignette.c

FileList > comp-rlitt_pure_vignette > src > comp_rlitt_pure_vignette.c

Go to the source code of this file

A rlitt_pure_vignette module. More...

• #include "comp_rlitt_pure_vignette.h"
• #include "bits/stdint-uintn.h"
• #include "computation_defs.h"
• #include "stdbool.h"
• #include "stdio.h"
• #include "stdlib.h"
• #include "tang_defs.h"

Public Static Attributes

Type	Name
bool	comp_rlitt_pure_vignette_executed = false The local computation status of the RLITT pure vignette computation module.
comp_rlitt_pure_vignette_config_t *	comp_rlitt_pure_vignette_localcfg = NULL The local configuration of the RLITT pure vignette computation module.
comp_rlitt_pure_vignette_result_t	comp_rlitt_pure_vignette_localrestult = {} The local result of the RLITT pure vignette computation module.
char	comp_rlitt_pure_vignette_str = { '\0' } The local string buffer of the RLITT pure vignette computation module.

Public Functions

Type	Name
uint8_t	comp_rlitt_pure_vignette_compute () A public function, calling this executes the computation on the configured tangle.
uint8_t	comp_rlitt_pure_vignette_config (comp_rlitt_pure_vignette_config_t * config_arg) The public configuration function.
const comp_rlitt_pure_vignette_result_t *	comp_rlitt_pure_vignette_result () A public function, calling this retrieves the results of the last computation.
STATIC_INLINE_UINT8	comp_rlitt_pure_vignette_walk_tree (const note_wptt_t * tree) Walk the input tree and determine paren set for each vertex.

Macros

Type	Name
define	COMP_RLITT_PURE_VIGNETTE_STACK_SIZE ([**UTIL\_TANG\_DEFS\_MAX\_CROSSINGNUM**](tang__defs_8h.md#define-util_tang_defs_max_crossingnum))
define	COMP_RLITT_PURE_VIGNETTE_STR_BUFF_SIZE ([**UTIL\_TANG\_DEFS\_MAX\_CROSSINGNUM**](tang__defs_8h.md#define-util_tang_defs_max_crossingnum) \* 0x3u)

Detailed Description

Author:

Joe Starr

Public Static Attributes Documentation

variable comp_rlitt_pure_vignette_executed

The local computation status of the RLITT pure vignette computation module.

bool comp_rlitt_pure_vignette_executed;

---

variable comp_rlitt_pure_vignette_localcfg

The local configuration of the RLITT pure vignette computation module.

comp_rlitt_pure_vignette_config_t* comp_rlitt_pure_vignette_localcfg;

---

variable comp_rlitt_pure_vignette_localrestult

The local result of the RLITT pure vignette computation module.

comp_rlitt_pure_vignette_result_t comp_rlitt_pure_vignette_localrestult;

---

variable comp_rlitt_pure_vignette_str

The local string buffer of the RLITT pure vignette computation module.

char comp_rlitt_pure_vignette_str[COMP_RLITT_PURE_VIGNETTE_STR_BUFF_SIZE];

---

Public Functions Documentation

function comp_rlitt_pure_vignette_compute

A public function, calling this executes the computation on the configured tangle.

uint8_t comp_rlitt_pure_vignette_compute () 

Returns:

uint8_t Generation status info.

---

function comp_rlitt_pure_vignette_config

The public configuration function.

uint8_t comp_rlitt_pure_vignette_config (
    comp_rlitt_pure_vignette_config_t * config_arg
) 

Parameters:

• config_arg The config to set.

---

function comp_rlitt_pure_vignette_result

A public function, calling this retrieves the results of the last computation.

const comp_rlitt_pure_vignette_result_t * comp_rlitt_pure_vignette_result () 

Returns:

comp_rlitt_pure_vignette_result_t Computation results.

---

function comp_rlitt_pure_vignette_walk_tree

Walk the input tree and determine paren set for each vertex.

STATIC_INLINE_UINT8 comp_rlitt_pure_vignette_walk_tree (
    const note_wptt_t * tree
) 

Parameters:

• tree The tree to walk.

Returns:

A status indicator for the function.

---

Macro Definition Documentation

define COMP_RLITT_PURE_VIGNETTE_STACK_SIZE

#define COMP_RLITT_PURE_VIGNETTE_STACK_SIZE `( UTIL_TANG_DEFS_MAX_CROSSINGNUM )`

---

define COMP_RLITT_PURE_VIGNETTE_STR_BUFF_SIZE

#define COMP_RLITT_PURE_VIGNETTE_STR_BUFF_SIZE `( UTIL_TANG_DEFS_MAX_CROSSINGNUM * 0x3u)`

---

---

The documentation for this class was generated from the following file source/comp-rlitt_pure_vignette/src/comp_rlitt_pure_vignette.c