File comp_wptt_vertex_canonicity.h

FileList > comp-wptt_vertex_canonicity > src > comp_wptt_vertex_canonicity.h

A module for computing the canonicity of a vertex of a wptt. More...

#include "computation_defs.h"
#include "notation_wptt.h"
#include "stdbool.h"
#include "stdlib.h"
#include "string.h"
#include "storage_defs.h"
#include <stdint.h>

Classes

Type	Name
struct	comp_wptt_vert_canon_config_t The type definition for configuring the root_neut_rlitt computation.
struct	comp_wptt_vert_canon_result_t The type definition for configuring the root_neut_rlitt computation.

Public Types

Type	Name
enum	comp_wptt_vert_canon_canon_e Type defining the order direction of a node in a wptt.
typedef enum comp_wptt_vert_canon_canon_e	comp_wptt_vert_canon_canon_e Type defining the order direction of a node in a wptt.
enum	comp_wptt_vert_canon_positivity_e Type defining the order direction of a node in a wptt.
typedef enum comp_wptt_vert_canon_positivity_e	comp_wptt_vert_canon_positivity_e Type defining the order direction of a node in a wptt.

Public Functions

Type	Name
uint8_t	comp_wptt_vert_canon_compute () A public function, calling this executes the computation on the configured tangle.
uint8_t	comp_wptt_vert_canon_config (comp_wptt_vert_canon_config_t * config_arg) The public configuration function.
const comp_wptt_vert_canon_result_t *	comp_wptt_vert_canon_result () A public function, calling this retrieves the results of the last computation.

Macros

Type	Name
define	COMP_WPTT_VERT_CANON_COMPUTE_ALREADY_COMPUTED `(0x1u << 2u)` Failed to configure the module due to null config.
define	COMP_WPTT_VERT_CANON_COMPUTE_CFG_ERROR `(0x1u << 1u)` Failed to configure the module due to null config.
define	COMP_WPTT_VERT_CANON_CONFIG_IS_NULL `(0x1u << 2u)` Failed to configure the module due to null config.
define	COMP_WPTT_VERT_CANON_CONFIG_PARAM `(0x1u << 1u)` Failed to configure the module due to issue in rootstock.

Detailed Description

Author:

Joe Starr

Public Types Documentation

enum comp_wptt_vert_canon_canon_e

Type defining the order direction of a node in a wptt.

enum comp_wptt_vert_canon_canon_e {
    COMP_WPTT_VERT_CANON_CAN_UNINIT,
    COMP_WPTT_VERT_CANON_IS_CANONICAL,
    COMP_WPTT_VERT_CANON_IS_NONCANONICAL
};

typedef comp_wptt_vert_canon_canon_e

Type defining the order direction of a node in a wptt.

typedef enum comp_wptt_vert_canon_canon_e comp_wptt_vert_canon_canon_e;

enum comp_wptt_vert_canon_positivity_e

Type defining the order direction of a node in a wptt.

enum comp_wptt_vert_canon_positivity_e {
    COMP_WPTT_VERT_CANON_POS_UNINIT,
    COMP_WPTT_VERT_CANON_POS_POS,
    COMP_WPTT_VERT_CANON_POS_NEG
};

typedef comp_wptt_vert_canon_positivity_e

Type defining the order direction of a node in a wptt.

typedef enum comp_wptt_vert_canon_positivity_e comp_wptt_vert_canon_positivity_e;

Public Functions Documentation

function comp_wptt_vert_canon_compute

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

uint8_t comp_wptt_vert_canon_compute ()

Returns:

uint8_t Generation status info.

function comp_wptt_vert_canon_config

The public configuration function.

uint8_t comp_wptt_vert_canon_config (
    comp_wptt_vert_canon_config_t * config_arg
)

Parameters:

config_arg The config to set.

function comp_wptt_vert_canon_result

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

const comp_wptt_vert_canon_result_t * comp_wptt_vert_canon_result ()

Returns:

comp_wptt_vert_canon_result_t Computation results.

Macro Definition Documentation

define COMP_WPTT_VERT_CANON_COMPUTE_ALREADY_COMPUTED

Failed to configure the module due to null config.

#define COMP_WPTT_VERT_CANON_COMPUTE_ALREADY_COMPUTED `(0x1u << 2u)`

define COMP_WPTT_VERT_CANON_COMPUTE_CFG_ERROR

Failed to configure the module due to null config.

#define COMP_WPTT_VERT_CANON_COMPUTE_CFG_ERROR `(0x1u << 1u)`

define COMP_WPTT_VERT_CANON_CONFIG_IS_NULL

Failed to configure the module due to null config.

#define COMP_WPTT_VERT_CANON_CONFIG_IS_NULL `(0x1u << 2u)`

define COMP_WPTT_VERT_CANON_CONFIG_PARAM

Failed to configure the module due to issue in rootstock.

#define COMP_WPTT_VERT_CANON_CONFIG_PARAM `(0x1u << 1u)`

The documentation for this class was generated from the following file source/comp-wptt_vertex_canonicity/src/comp_wptt_vertex_canonicity.h