The VdmaError class represents an error that can occur during vector operations. More...

#include <vector_error.hpp>

Public Member Functions
	VdmaError ()=default

	~VdmaError ()=default

bool	isSuccessful () const
	Check if the vector operation was successful. More...

bool	isUnderflowed () const
	Check if the vector function has encountered at least one underflow error. More...

bool	isOverflowed () const
	Check if the vector function has encountered at least one overflow error. More...

bool	isNan () const
	Check if the vector function has encountered at least one NaN error. More...

bool	isOutOfRange () const
	Check if the vector function received an out-of-range index parameter. More...

bool	isInvalidAddress () const
	Check if the vector function input parameter has some invalid addresses. More...

bool	isInvalidOperation () const
	Check if the vector operation was invalid. More...

bool	isDeprecated () const
	Check if the vector operation is deprecated. More...

bool	isNotSupported () const
	Check if the vector operation is not supported. More...

VdmaError &	setUnderflowed ()

VdmaError &	setOverflowed ()

VdmaError &	setNan ()

VdmaError &	setOutOfRange ()

VdmaError &	setInvalidAddress ()

VdmaError &	setInvalidOperation ()

VdmaError &	setDeprecated ()

VdmaError &	setNotSupported ()

VdmaError &	clear ()

Detailed Description

The VdmaError class represents an error that can occur during vector operations.

This class provides methods to check and set various error states that may occur during vector operations, such as underflow, overflow, NaN, out-of-range, and more.

Definition at line 17 of file vector_error.hpp.

Constructor & Destructor Documentation

◆ VdmaError()

mu::vector::VdmaError::VdmaError ( )

default

◆ ~VdmaError()

mu::vector::VdmaError::~VdmaError ( )

default

Member Function Documentation

◆ clear()

VdmaError& mu::vector::VdmaError::clear ( )

◆ isDeprecated()

bool mu::vector::VdmaError::isDeprecated ( ) const

Check if the vector operation is deprecated.

This method returns true if the operation used is deprecated.

Returns: bool True if the operation is deprecated, false otherwise.

◆ isInvalidAddress()

bool mu::vector::VdmaError::isInvalidAddress ( ) const

Check if the vector function input parameter has some invalid addresses.

This method returns true if an invalid address error occurred during the vector operation.

Returns: bool True if an invalid address error occurred, false otherwise.

◆ isInvalidOperation()

bool mu::vector::VdmaError::isInvalidOperation ( ) const

Check if the vector operation was invalid.

This method returns true if an invalid operation error occurred during the vector operation.

Returns: bool True if an invalid operation error occurred, false otherwise.

◆ isNan()

bool mu::vector::VdmaError::isNan ( ) const

Check if the vector function has encountered at least one NaN error.

This method returns true if a NaN error occurred during the vector operation.

Returns: bool True if a NaN error occurred, false otherwise.

◆ isNotSupported()

bool mu::vector::VdmaError::isNotSupported ( ) const

Check if the vector operation is not supported.

This method returns true if the operation is not supported.

Returns: bool True if the operation is not supported, false otherwise.

◆ isOutOfRange()

bool mu::vector::VdmaError::isOutOfRange ( ) const

Check if the vector function received an out-of-range index parameter.

This method returns true if an out-of-range error occurred during the vector operation.

Returns: bool True if an out-of-range error occurred, false otherwise.

◆ isOverflowed()

bool mu::vector::VdmaError::isOverflowed ( ) const

Check if the vector function has encountered at least one overflow error.

This method returns true if an overflow error occurred during the vector operation.

Returns: bool True if an overflow error occurred, false otherwise.

◆ isSuccessful()

bool mu::vector::VdmaError::isSuccessful ( ) const

Check if the vector operation was successful.

This method returns true if no errors were encountered during the vector operation.

Returns: bool True if the operation was successful, false otherwise.

◆ isUnderflowed()

bool mu::vector::VdmaError::isUnderflowed ( ) const

Check if the vector function has encountered at least one underflow error.

This method returns true if an underflow error occurred during the vector operation.

Returns: bool True if an underflow error occurred, false otherwise.

◆ setDeprecated()

VdmaError& mu::vector::VdmaError::setDeprecated ( )

◆ setInvalidAddress()

VdmaError& mu::vector::VdmaError::setInvalidAddress ( )

◆ setInvalidOperation()

VdmaError& mu::vector::VdmaError::setInvalidOperation ( )

◆ setNan()

VdmaError& mu::vector::VdmaError::setNan ( )

◆ setNotSupported()

VdmaError& mu::vector::VdmaError::setNotSupported ( )

◆ setOutOfRange()

VdmaError& mu::vector::VdmaError::setOutOfRange ( )

◆ setOverflowed()

VdmaError& mu::vector::VdmaError::setOverflowed ( )

◆ setUnderflowed()

VdmaError& mu::vector::VdmaError::setUnderflowed ( )

The documentation for this class was generated from the following file:

vector_error.hpp

Public Member Functions