File comp_rational_data.h
FileList > comp-rational_data > src > comp_rational_data.h
Go to the source code of this file
A module for compute rational tangle data: fraction, algebraic equivlance, and parity. More...
#include "computation_defs.h"#include "notation_tv.h"#include "storage_defs.h"#include "stdbool.h"#include "stdlib.h"#include "string.h"
Classes
| Type | Name |
|---|---|
| struct | comp_rational_data_config_t The type definition for configuring the rational data computation. |
| struct | comp_rational_data_result_t The type definition for configuring the rational data computation. |
Public Functions
| Type | Name |
|---|---|
| uint8_t | comp_rational_data_compute () A public function, calling this executes the computation on the configured tangle. |
| uint8_t | comp_rational_data_config (comp_rational_data_config_t * config_arg) The public configuration function. |
| const comp_rational_data_result_t * | comp_rational_data_result () A public function, calling this retrieves the results of the last computation. |
Macros
| Type | Name |
|---|---|
| define | COMP_RATIONAL_DAT_CONFIG_BUFFER (0x1u << 2u)Failed to configure the module due to issue in buffer. |
| define | COMP_RATIONAL_DAT_CONFIG_IS_NULL (0x1u << 1u)Failed to configure the module due to null config. |
| define | COMP_RATIONAL_DAT_CONFIG_STR_BUFFER (0x1u << 3u)Failed to configure the module due to issue in string buffer. |
| define | COMP_RATIONAL_DAT_STORAGE_UKEY ("COMP\_RATIONAL\_DAT")The key for the rational data computation. |
Detailed Description
Author:
Isabel Darcy
Author:
Joe Starr
Public Functions Documentation
function comp_rational_data_compute
A public function, calling this executes the computation on the configured tangle.
uint8_t comp_rational_data_compute ()
Returns:
uint8_t computation status info.
function comp_rational_data_config
The public configuration function.
uint8_t comp_rational_data_config (
comp_rational_data_config_t * config_arg
)
Parameters:
config_argThe config to set.
function comp_rational_data_result
A public function, calling this retrieves the results of the last computation.
const comp_rational_data_result_t * comp_rational_data_result ()
Returns:
comp_rational_data_result_t Computation results.
Macro Definition Documentation
define COMP_RATIONAL_DAT_CONFIG_BUFFER
Failed to configure the module due to issue in buffer.
#define COMP_RATIONAL_DAT_CONFIG_BUFFER `(0x1u << 2u)`
define COMP_RATIONAL_DAT_CONFIG_IS_NULL
Failed to configure the module due to null config.
#define COMP_RATIONAL_DAT_CONFIG_IS_NULL `(0x1u << 1u)`
define COMP_RATIONAL_DAT_CONFIG_STR_BUFFER
Failed to configure the module due to issue in string buffer.
#define COMP_RATIONAL_DAT_CONFIG_STR_BUFFER `(0x1u << 3u)`
define COMP_RATIONAL_DAT_STORAGE_UKEY
The key for the rational data computation.
#define COMP_RATIONAL_DAT_STORAGE_UKEY `("COMP_RATIONAL_DAT")`
The documentation for this class was generated from the following file source/comp-rational_data/src/comp_rational_data.h