File comp_wptt_canonicity.c

FileList > comp-wptt_canonicity > src > comp_wptt_canonicity.c

Go to the source code of this file

A module for computing the canonicity of a WPTT. More...

• #include "comp_wptt_canonicity.h"
• #include "bits/stdint-uintn.h"
• #include "comp_wptt_vertex_canonicity.h"
• #include "computation_defs.h"
• #include "notation_defs.h"
• #include "stdbool.h"
• #include "stdint.h"
• #include "stdio.h"
• #include "stdlib.h"
• #include "sys/types.h"
• #include "tang_defs.h"

Public Static Attributes

Type	Name
bool	comp_wptt_canonicity_executed = true File scoped variable for storing the execution state of the module.
comp_wptt_canonicity_config_t *	comp_wptt_canonicity_localcfg = NULL File scoped variable for storing the configuration of the next run.
comp_wptt_canonicity_result_t	comp_wptt_canonicity_localrestult File scoped variable for storing result of the previous computation.

Public Functions

Type	Name
uint8_t	comp_wptt_canonicity_compute () The public compute function. Calling this executes the computation on the configured data.
uint8_t	comp_wptt_canonicity_config (comp_wptt_canonicity_config_t * config_arg) The public configuration function.
const comp_wptt_canonicity_result_t *	comp_wptt_canonicity_result () The public result function. Calling this retrieves the result of the computation on the configured data.
STATIC_INLINE_UINT8	comp_wptt_canonicity_walk_tree () Walk the input tree and determine the canonicity of each vertex.
STATIC_INLINE comp_wptt_vert_canon_positivity_e	comp_wptt_vert_canon_convert_pos (comp_wptt_cononicity_positivity_e pos) Convert the enum from the global version to the local vertex version.

Macros

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

Detailed Description

Author:

Joe Starr

Public Static Attributes Documentation

variable comp_wptt_canonicity_executed

File scoped variable for storing the execution state of the module.

bool comp_wptt_canonicity_executed;

---

variable comp_wptt_canonicity_localcfg

File scoped variable for storing the configuration of the next run.

comp_wptt_canonicity_config_t* comp_wptt_canonicity_localcfg;

---

variable comp_wptt_canonicity_localrestult

File scoped variable for storing result of the previous computation.

comp_wptt_canonicity_result_t comp_wptt_canonicity_localrestult;

---

Public Functions Documentation

function comp_wptt_canonicity_compute

The public compute function. Calling this executes the computation on the configured data.

uint8_t comp_wptt_canonicity_compute () 

Returns:

uint8_t Generation status info.

---

function comp_wptt_canonicity_config

The public configuration function.

uint8_t comp_wptt_canonicity_config (
    comp_wptt_canonicity_config_t * config_arg
) 

Parameters:

• config_arg The config to set.

---

function comp_wptt_canonicity_result

The public result function. Calling this retrieves the result of the computation on the configured data.

const comp_wptt_canonicity_result_t * comp_wptt_canonicity_result () 

Returns:

uint8_t Generation status info.

---

function comp_wptt_canonicity_walk_tree

Walk the input tree and determine the canonicity of each vertex.

STATIC_INLINE_UINT8 comp_wptt_canonicity_walk_tree () 

Parameters:

• tree The tree to walk.

Returns:

A status indicator for the function.

---

function comp_wptt_vert_canon_convert_pos

Convert the enum from the global version to the local vertex version.

STATIC_INLINE comp_wptt_vert_canon_positivity_e comp_wptt_vert_canon_convert_pos (
    comp_wptt_cononicity_positivity_e pos
) 

Parameters:

• pos The positivity condition to check for the whole tree

Returns:

The vertex enum representation for the positivity condition.

---

Macro Definition Documentation

define COMP_WPTT_CANON_STACK_SIZE

#define COMP_WPTT_CANON_STACK_SIZE `( UTIL_TANG_DEFS_MAX_CROSSINGNUM )`

---

---

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