Interface to be implemented by all classes representing values.
More...
|
std::ostream & | operator<< (std::ostream &a_Stream, const IValue &a_Val) |
| Overloaded streaming operator for outputting the value type into an std::ostream. More...
|
|
Interface to be implemented by all classes representing values.
IValue is the common base class of both the Value and Variable classes.
◆ GetDim()
int mup::IValue::GetDim |
( |
| ) |
const |
|
inline |
Returns the dimension of the value represented by a value object.
The value represents the dimension of the object. Possible value are:
-
0 - scalar
-
1 - vector
-
2 - matrix
◆ IsComplex()
bool mup::IValue::IsComplex |
( |
| ) |
const |
|
inline |
Returns true if this value is a complex value.
- Exceptions
-
◆ IsInteger()
bool mup::IValue::IsInteger |
( |
| ) |
const |
|
inline |
Returns true if this value is a noncomplex integer.
- Exceptions
-
◆ IsMatrix()
bool mup::IValue::IsMatrix |
( |
| ) |
const |
|
inline |
Returns true if this value is an array.
- Exceptions
-
◆ IsNonComplexScalar()
bool mup::IValue::IsNonComplexScalar |
( |
| ) |
const |
|
inline |
Returns true if the type is either floating point or interger.
- Exceptions
-
◆ IsScalar()
bool mup::IValue::IsScalar |
( |
| ) |
const |
|
inline |
Returns true if the type is not a vector and not a string.
- Exceptions
-
◆ IsScalarOrBool()
bool mup::IValue::IsScalarOrBool |
( |
| ) |
const |
|
inline |
Returns true if this value represents a scalar value or a boolean value.
Added to fix #117
◆ IsString()
bool mup::IValue::IsString |
( |
| ) |
const |
|
inline |
Returns true if this value is a string value.
- Exceptions
-
◆ operator<<
std::ostream& operator<< |
( |
std::ostream & |
a_Stream, |
|
|
const IValue & |
a_Val |
|
) |
| |
|
friend |
Overloaded streaming operator for outputting the value type into an std::ostream.
- Parameters
-
a_Stream | The stream object |
a_Val | The value object to be streamed This function is only present if MUP_USE_WIDE_STRING is not defined. |