Optional< T > Class Template Reference

#include <Optional.hpp>

Inheritance diagram for Optional< T >:

Collaboration diagram for Optional< T >:

Public Types
using	BaseSwitch = OptionalReferenceSwitch<std::is_reference<T>::value, T>
Public Types inherited from OptionalReferenceSwitch< std::is_reference< T >::value, T >
using	Base

Public Member Functions
	Optional () noexcept
	Optional (const T &value)
Optional &	operator= (const Optional &other)=default
	Optional (EmptyOptional empty)
	Optional (const Optional &other)
	Optional (const BaseSwitch &other)
template<class... Args>
	Optional (ConstructInPlace, Args &&... args)
bool	operator== (const Optional< T > &rhs) const
	Two optionals are considered equal if they are both empty or both contain values which themselves are considered equal (via their own == operator).
Public Member Functions inherited from OptionalReferenceSwitch< std::is_reference< T >::value, T >
	OptionalReferenceSwitch () noexcept
	OptionalReferenceSwitch (EmptyOptional) noexcept
	OptionalReferenceSwitch (const T &value)
	OptionalReferenceSwitch (ConstructInPlace, Args &&... args)
	OptionalReferenceSwitch (const OptionalReferenceSwitch &other)
OptionalReferenceSwitch &	operator= (const T &value)
OptionalReferenceSwitch &	operator= (const OptionalReferenceSwitch &other)
OptionalReferenceSwitch &	operator= (EmptyOptional)
	~OptionalReferenceSwitch ()
void	reset ()
const T &	value () const
T &	value ()
Public Member Functions inherited from OptionalBase
	OptionalBase () noexcept
bool	has_value () const noexcept
	operator bool () const noexcept
	Conversion to bool, so can be used in if-statements and similar contexts expecting a bool.

Additional Inherited Members
Protected Member Functions inherited from OptionalBase
	OptionalBase (bool hasValue) noexcept
Protected Attributes inherited from OptionalBase
bool	m_HasValue

Detailed Description

template<typename T>
class armnn::Optional< T >

Definition at line 270 of file Optional.hpp.

Member Typedef Documentation

BaseSwitch

template<typename T >

using BaseSwitch = OptionalReferenceSwitch<std::is_reference<T>::value, T>

Definition at line 273 of file Optional.hpp.

Constructor & Destructor Documentation

Optional() [1/6]

template<typename T >

Optional ( )

inlinenoexcept

Definition at line 275 of file Optional.hpp.

: BaseSwitch{} {}

Optional() [2/6]

template<typename T >

Optional ( const T & value )

inline

Definition at line 276 of file Optional.hpp.

: BaseSwitch{value} {}

Optional() [3/6]

template<typename T >

Optional ( EmptyOptional< T > empty )

inline

Definition at line 278 of file Optional.hpp.

: BaseSwitch{empty} {}

Optional() [4/6]

template<typename T >

Optional ( const Optional< T > & other )

inline

Definition at line 279 of file Optional.hpp.

: BaseSwitch{other} {}

Optional() [5/6]

template<typename T >

Optional ( const BaseSwitch & other )

inline

Definition at line 280 of file Optional.hpp.

: BaseSwitch{other} {}

Optional() [6/6]

template<typename T >

template<class... Args>

Optional ( ConstructInPlace , Args &&... args )

inlineexplicit

Definition at line 283 of file Optional.hpp.

                                                        :
        BaseSwitch(CONSTRUCT_IN_PLACE, std::forward<Args>(args)...) {}

Member Function Documentation

operator=()

template<typename T >

Optional & operator= ( const Optional< T > & other )

default

operator==()

template<typename T >

bool operator== ( const Optional< T > & rhs ) const

inline

Two optionals are considered equal if they are both empty or both contain values which themselves are considered equal (via their own == operator).

Definition at line 288 of file Optional.hpp.

    {
        if (!this->has_value() && !rhs.has_value())
        {
            return true;
        }
        if (this->has_value() && rhs.has_value() && this->value() == rhs.value())
        {
            return true;
        }
        return false;
    }

References OptionalBase::has_value(), and OptionalReferenceSwitch< IsReference, T >::value().

---

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

• include/armnn/Optional.hpp