steppable::types Namespace Reference

The namespace containing types used in the steppable calculator. More...

Classes
class	ResultBase
	A base class for a result of a calculation. You should use the Result and ResultBool aliases instead of this class, which has the Status and StatusBool enums as the status type respectively. More...

Typedefs
template<typename ResultT>
using	Result = ResultBase<Status, ResultT, StringLiteral{ "str" }>
	An alias for a result of a calculation. This represents a calculation with a Status status.
template<typename ResultT>
using	ResultBool = ResultBase<StatusBool, ResultT, StringLiteral{ "bool" }>
	An alias for a result of a boolean calculation.

Enumerations
enum class	Status : std::uint8_t { CALCULATED_SIMPLIFIED , CALCULATED_UNSIMPLIFIED , MATH_ERROR }
	The status of the calculation. More...
enum class	StatusBool : std::uint8_t {   CALCULATED_SIMPLIFIED_YES , CALCULATED_SIMPLIFIED_NO , CALCULATED_UNSIMPLIFIED_YES , CALCULATED_UNSIMPLIFIED_NO ,   MATH_ERROR }
	The status of a boolean calculation. More...

Detailed Description

The namespace containing types used in the steppable calculator.

Typedef Documentation

Result

template<typename ResultT>

using steppable::types::Result = ResultBase<Status, ResultT, StringLiteral{ "str" }>

An alias for a result of a calculation. This represents a calculation with a Status status.

ResultBool

template<typename ResultT>

using steppable::types::ResultBool = ResultBase<StatusBool, ResultT, StringLiteral{ "bool" }>

An alias for a result of a boolean calculation.

Enumeration Type Documentation

Status

enum class steppable::types::Status : std::uint8_t

strong

The status of the calculation.

Enumerator
CALCULATED_SIMPLIFIED	The calculation is done by taking simplified steps.
CALCULATED_UNSIMPLIFIED	The calculation is done.
MATH_ERROR	The calculation is not done because of an error.

StatusBool

enum class steppable::types::StatusBool : std::uint8_t

strong

The status of a boolean calculation.

Enumerator
CALCULATED_SIMPLIFIED_YES	The calculation is done by taking simplified steps, the result it True.
CALCULATED_SIMPLIFIED_NO	The calculation is done by taking simplified steps, the result it False.
CALCULATED_UNSIMPLIFIED_YES	The calculation is done, the result it True.
CALCULATED_UNSIMPLIFIED_NO	The calculation is done, the result it False.
MATH_ERROR	The calculation is not done because of an error.