File comp_rlitt_grafting.c

FileList > comp-rlitt_grafting > src > comp_rlitt_grafting.c

A rlitt_grafting module. More...

#include "comp_rlitt_grafting.h"
#include "bits/stdint-intn.h"
#include "stdbool.h"
#include "stdint.h"
#include "stdio.h"
#include "stdlib.h"

Public Static Attributes

Type	Name
bool	comp_rlitt_grafting_executed = `false` The local computation status of the rlitt grafting module.
comp_rlitt_grafting_config_t *	comp_rlitt_grafting_localcfg = `NULL` The local configuration of the rlitt grafting module.
note_wptt_node_t *	comp_rlitt_grafting_localnodes The local configuration of the rlitt grafting module.
comp_rlitt_grafting_result_t	comp_rlitt_grafting_localrestult = `{ NULL }` The local result of the rlitt grafting module.
size_t	comp_rlitt_grafting_nodes_count = `0` The local configuration of the rlitt grafting module.
size_t	comp_rlitt_grafting_nodes_idx = `0` The local configuration of the rlitt grafting module.

Public Functions

Type	Name
uint8_t	comp_rlitt_grafting_compute () A public function, calling this executes the computation on the configured tangle.
uint8_t	comp_rlitt_grafting_config (comp_rlitt_grafting_config_t * config_arg) The public configuration function.
STATIC_INLINE void	comp_rlitt_grafting_copy_nodevals (const note_wptt_node_t * src, note_wptt_node_t * dest) Copies values of a vertex to a new vertex.
STATIC_INLINE_UINT8	comp_rlitt_grafting_copy_tree (const note_wptt_t * tree) Copies a given tree into the output buffer.
STATIC_INLINE_UINT8	comp_rlitt_grafting_graft (note_wptt_node_t * scion) Graft a scion onto the idx element of the rootstock.
const comp_rlitt_grafting_result_t *	comp_rlitt_grafting_result () A public function, calling this retrieves the results of the last computation.

Macros

Type	Name
define	COMP_RLITT_GRAFTING_STACK_SIZE `([UTIL\_TANG\_DEFS\_MAX\_CROSSINGNUM](tang__defs_8h.md#define-util_tang_defs_max_crossingnum))` The maximum size of the stack used for walking the trees.

Detailed Description

Author:

Joe Starr

Public Static Attributes Documentation

variable comp_rlitt_grafting_executed

The local computation status of the rlitt grafting module.

bool comp_rlitt_grafting_executed;

variable comp_rlitt_grafting_localcfg

The local configuration of the rlitt grafting module.

comp_rlitt_grafting_config_t* comp_rlitt_grafting_localcfg;

variable comp_rlitt_grafting_localnodes

The local configuration of the rlitt grafting module.

note_wptt_node_t* comp_rlitt_grafting_localnodes;

variable comp_rlitt_grafting_localrestult

The local result of the rlitt grafting module.

comp_rlitt_grafting_result_t comp_rlitt_grafting_localrestult;

variable comp_rlitt_grafting_nodes_count

The local configuration of the rlitt grafting module.

size_t comp_rlitt_grafting_nodes_count;

variable comp_rlitt_grafting_nodes_idx

The local configuration of the rlitt grafting module.

size_t comp_rlitt_grafting_nodes_idx;

Public Functions Documentation

function comp_rlitt_grafting_compute

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

uint8_t comp_rlitt_grafting_compute ()

Returns:

uint8_t computation status info.

function comp_rlitt_grafting_config

The public configuration function.

uint8_t comp_rlitt_grafting_config (
    comp_rlitt_grafting_config_t * config_arg
)

Parameters:

config_arg The config to set.

function comp_rlitt_grafting_copy_nodevals

Copies values of a vertex to a new vertex.

STATIC_INLINE void comp_rlitt_grafting_copy_nodevals (
    const note_wptt_node_t * src,
    note_wptt_node_t * dest
)

Parameters:

src The source vertex.
dest The destination vertex.

function comp_rlitt_grafting_copy_tree

Copies a given tree into the output buffer.

STATIC_INLINE_UINT8 comp_rlitt_grafting_copy_tree (
    const note_wptt_t * tree
)

Parameters:

tree The tree to copy into the output buffer.

Returns:

A flag indicating success of the copy.

function comp_rlitt_grafting_graft

Graft a scion onto the idx element of the rootstock.

STATIC_INLINE_UINT8 comp_rlitt_grafting_graft (
    note_wptt_node_t * scion
)

We copied the rootstock into a new buffer so that buffer is in index order. We can directly access the ith element for grafting.

Parameters:

scion The scion for processing.

Returns:

A status indicator for the operation

function comp_rlitt_grafting_result

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

const comp_rlitt_grafting_result_t * comp_rlitt_grafting_result ()

Returns:

comp_rlitt_grafting_result_t Computation results.

Macro Definition Documentation

define COMP_RLITT_GRAFTING_STACK_SIZE

The maximum size of the stack used for walking the trees.

#define COMP_RLITT_GRAFTING_STACK_SIZE `( UTIL_TANG_DEFS_MAX_CROSSINGNUM )`

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