File mut_rlitt_ringshift.h
FileList > mut-rlitt_ringshift > src > mut_rlitt_ringshift.h
Go to the source code of this file
A module for compute rlitt_ringshift. More...
#include "mutator_defs.h"#include "storage_defs.h"#include "notation_wptt.h"#include "stdbool.h"#include "stdlib.h"#include "string.h"
Classes
| Type | Name |
|---|---|
| struct | mut_rlitt_ringshift_config_t The type definition for configuring the rlitt_ringshift computation. |
Public Functions
| Type | Name |
|---|---|
| uint8_t | mut_rlitt_ringshift_config (mut_rlitt_ringshift_config_t * config_arg) The public configuration function. |
| uint8_t | mut_rlitt_ringshift_mutate () A public function, calling this executes the computation on the configured tangle. |
Macros
| Type | Name |
|---|---|
| define | MUT_RLITT_RINGSHIFT_CONFIG_IS_NULL (0X1U << 2U)Failed to configure the module due to null config. |
| define | MUT_RLITT_RINGSHIFT_CONFIG_WPTT (0X1U << 1U)Failed to configure the module due to issue in rootstock. |
| define | MUT_RLITT_RINGSHIFT_MUTATE_ALREADY_COMPUTED (0X1U << 2U)Failed to configure the module due to the config having been previously computed against. |
| define | MUT_RLITT_RINGSHIFT_MUTATE_CFG_ERROR (0X1U << 1U)Failed to configure the module due to null config. |
Detailed Description
Author:
Joe Starr
Public Functions Documentation
function mut_rlitt_ringshift_config
The public configuration function.
uint8_t mut_rlitt_ringshift_config (
mut_rlitt_ringshift_config_t * config_arg
)
Parameters:
config_argThe config to set.
function mut_rlitt_ringshift_mutate
A public function, calling this executes the computation on the configured tangle.
uint8_t mut_rlitt_ringshift_mutate ()
Returns:
uint8_t Generation status info.
Macro Definition Documentation
define MUT_RLITT_RINGSHIFT_CONFIG_IS_NULL
Failed to configure the module due to null config.
#define MUT_RLITT_RINGSHIFT_CONFIG_IS_NULL `(0X1U << 2U)`
define MUT_RLITT_RINGSHIFT_CONFIG_WPTT
Failed to configure the module due to issue in rootstock.
#define MUT_RLITT_RINGSHIFT_CONFIG_WPTT `(0X1U << 1U)`
define MUT_RLITT_RINGSHIFT_MUTATE_ALREADY_COMPUTED
Failed to configure the module due to the config having been previously computed against.
#define MUT_RLITT_RINGSHIFT_MUTATE_ALREADY_COMPUTED `(0X1U << 2U)`
define MUT_RLITT_RINGSHIFT_MUTATE_CFG_ERROR
Failed to configure the module due to null config.
#define MUT_RLITT_RINGSHIFT_MUTATE_CFG_ERROR `(0X1U << 1U)`
The documentation for this class was generated from the following file source/mut-rlitt_ringshift/src/mut_rlitt_ringshift.h