module Bones
The Bones
module keeps all the Bones
classes and constants together. It contains the classes:
-
Engine
The main component of theBones
tool, providing the high-level tool flow. -
Preprocessor
A C-preprocessor, extracting class information from source code. -
Algorithm
An individual algorithm, containing an algorithm classification, code and more. -
Species
A class representing an algorithm class (or: species). -
Variable
A class for individual variables (not related to CAST). -
Structure
A class inheriting from theString
class, representing parts of the algorithm classification.
The module also contains a list of inter-class constants.
Constants
- ARROW
A string representing the production character (‘->’) of a species. See also
WEDGE
andPIPE
.- DEVICE
Constant to set the device variable name
- DIM_SEP
A string representing the comma character (‘,’) to separate different ranges.
- DIRECTIONS
Gives a list of all directions considered. Makes use of the
INPUT
andOUTPUT
constants.- END_DEFINITION
Set the end of a function definition, used in the skeleton library files. See also
START_DEFINITION
.- ERROR
A string given as a start of an error message. See also
MESSAGE
andWARNING
.- GLOBAL_ID
Sets the variable name for the global memory thread index in the skeleton library.
- GLOBAL_SIZE
Sets the variable name for the global memory size as used in the skeleton library.
- GOLDEN
Sets the name for the ‘golden’ output, required for verification purposes.
- INDENT
Set the tab size (currently: 2 spaces)
- INITIALIZATION_CODE
Provide a function call to the initialization C-code (if present). See als
INITIALIZATION_DEFINITION
.- INITIALIZATION_DEFINITION
Provide a function definition for the initialization C-code (if present). See als
INITIALIZATION_CODE
.- INOUT
Gives a string representing an read/write variable. See also
INPUT
,OUTPUT
andDIRECTIONS
.- INPUT
Gives a string representing an read-only variable. See also
OUTPUT
,INOUT
andDIRECTIONS
.- LOCAL_ID
Sets the variable name for the local memory thread index in the skeleton library.
- LOCAL_MEMORY
Sets the variable name for the local memory variable in the skeleton library.
- LOCAL_SIZE
Sets the variable name for the local memory size as used in the skeleton library.
- LOOP
Sets the loop variable name for the ‘golden’ output, required for verification purposes.
- MESSAGE
A string given as a start of an informative message. See also
ERROR
andWARNING
.- NL
Set the newline character
- OUTPUT
Gives a string representing an write-only variable. See also
INPUT
,INOUT
andDIRECTIONS
.- PIPE
A string representing the pipe character (‘|’) of a species. See also
WEDGE
andARROW
.- PRIVATE_MEMORY
Sets the variable name for the thread private (i.e. register) memory variable in the skeleton library.
- RANGE_SEP
A string representing the colon character (‘:’) to separate ranges in dimensions.
- SAR_MARKER1
Provides the starting marker for a search-and-replace variable. See also
SAR_MARKER2
.- SAR_MARKER2
Provides the ending marker for a search-and-replace variable. See also
SAR_MARKER1
.- START_DEFINITION
Set the start of a function definition, used in the skeleton library files. See also
END_DEFINITION
.- VARIABLE_PREFIX
Sets the prefix used by variables in the skeleton library. This is used in
LOCAL_MEMORY
,GLOBAL_ID
,LOCAL_ID
,GLOBAL_SIZE
andLOCAL_SIZE
.- WARNING
A string given as a start of an warning message. See also
ERROR
andMESSAGE
.- WEDGE
A string representing the combination character (‘^’) of a species. See also
ARROW
andPIPE
.