From fd627ffaec8fd8801d980b4c91ee7c0607ab6aaf Mon Sep 17 00:00:00 2001 From: Jan Eilers Date: Thu, 25 Feb 2021 17:44:00 +0000 Subject: IVGCVSW-5687 Update Doxygen Docu * Update Doxygen Documentation for 21.02 release Signed-off-by: Jan Eilers Change-Id: I9ed2f9caab038836ea99d7b378d7899fe431a4e5 --- 21.02/classarmnn_1_1_optional.xhtml | 472 ++++++++++++++++++++++++++++++++++++ 1 file changed, 472 insertions(+) create mode 100644 21.02/classarmnn_1_1_optional.xhtml (limited to '21.02/classarmnn_1_1_optional.xhtml') diff --git a/21.02/classarmnn_1_1_optional.xhtml b/21.02/classarmnn_1_1_optional.xhtml new file mode 100644 index 0000000000..cf9f4f2a2c --- /dev/null +++ b/21.02/classarmnn_1_1_optional.xhtml @@ -0,0 +1,472 @@ + + + + + + + + + + + + + +ArmNN: Optional< T > Class Template Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Member Functions | +List of all members
+
+
Optional< T > Class Template Referencefinal
+
+
+ +

#include <Optional.hpp>

+
+Inheritance diagram for Optional< T >:
+
+
+ + +OptionalReferenceSwitch< std::is_reference< T >::value, T > +OptionalBase + +
+ + + + + + + +

+Public Types

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

+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). More...
 
- 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. More...
 
+ + + + + + + +

+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

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

Definition at line 273 of file Optional.hpp.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ Optional() [1/6]

+ +
+
+ + + + + +
+ + + + + + + +
Optional ()
+ 		+inlinenoexcept
+
+ +

Definition at line 275 of file Optional.hpp.

+
275 : BaseSwitch{} {}
armnn::Optional::BaseSwitch
OptionalReferenceSwitch< std::is_reference< T >::value, T > BaseSwitch
Definition: Optional.hpp:273
+
+
+
+ +

◆ Optional() [2/6]

+ +
+
+ + + + + +
+ + + + + + + + +
Optional (const T & value)
+ 		+inline
+
+ +

Definition at line 276 of file Optional.hpp.

+
276 : BaseSwitch{value} {}
+
armnn::Optional::BaseSwitch
OptionalReferenceSwitch< std::is_reference< T >::value, T > BaseSwitch
Definition: Optional.hpp:273
+
+
+
+ +

◆ Optional() [3/6]

+ +
+
+ + + + + +
+ + + + + + + + +
Optional (EmptyOptional< T > empty)
+ 		+inline
+
+ +

Definition at line 278 of file Optional.hpp.

+
278 : BaseSwitch{empty} {}
armnn::Optional::BaseSwitch
OptionalReferenceSwitch< std::is_reference< T >::value, T > BaseSwitch
Definition: Optional.hpp:273
+
+
+
+ +

◆ Optional() [4/6]

+ +
+
+ + + + + +
+ + + + + + + + +
Optional (const Optional< T > & other)
+ 		+inline
+
+ +

Definition at line 279 of file Optional.hpp.

+
279 : BaseSwitch{other} {}
armnn::Optional::BaseSwitch
OptionalReferenceSwitch< std::is_reference< T >::value, T > BaseSwitch
Definition: Optional.hpp:273
+
+
+
+ +

◆ Optional() [5/6]

+ +
+
+ + + + + +
+ + + + + + + + +
Optional (const BaseSwitch & other)
+ 		+inline
+
+ +

Definition at line 280 of file Optional.hpp.

+
280 : BaseSwitch{other} {}
armnn::Optional::BaseSwitch
OptionalReferenceSwitch< std::is_reference< T >::value, T > BaseSwitch
Definition: Optional.hpp:273
+
+
+
+ +

◆ Optional() [6/6]

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

Definition at line 283 of file Optional.hpp.

+
283  :
284  BaseSwitch(CONSTRUCT_IN_PLACE, std::forward<Args>(args)...) {}
CONSTRUCT_IN_PLACE
#define CONSTRUCT_IN_PLACE
Definition: Optional.hpp:41
+
armnn::Optional::BaseSwitch
OptionalReferenceSwitch< std::is_reference< T >::value, T > BaseSwitch
Definition: Optional.hpp:273
+
+
+
+

Member Function Documentation

+ +

◆ operator=()

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

◆ operator==()

+ +
+
+ + + + + +
+ + + + + + + + +
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.

+
289  {
290  if (!this->has_value() && !rhs.has_value())
291  {
292  return true;
293  }
294  if (this->has_value() && rhs.has_value() && this->value() == rhs.value())
295  {
296  return true;
297  }
298  return false;
299  }
+
armnn::OptionalBase::has_value
bool has_value() const noexcept
Definition: Optional.hpp:53
+
+
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.1