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_base.xhtml | 320 +++++++++++++++++++++++++++++++ 1 file changed, 320 insertions(+) create mode 100644 21.02/classarmnn_1_1_optional_base.xhtml (limited to '21.02/classarmnn_1_1_optional_base.xhtml') diff --git a/21.02/classarmnn_1_1_optional_base.xhtml b/21.02/classarmnn_1_1_optional_base.xhtml new file mode 100644 index 0000000000..feee92160b --- /dev/null +++ b/21.02/classarmnn_1_1_optional_base.xhtml @@ -0,0 +1,320 @@ + + + + + + + + + + + + + +ArmNN: OptionalBase Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Member Functions | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
OptionalBase Class Reference
+
+
+ +

OptionalBase is the common functionality between reference and non-reference optional types. + More...

+ +

#include <Optional.hpp>

+
+Inheritance diagram for OptionalBase:
+
+
+ + +OptionalReferenceSwitch< IsReference, T > +OptionalReferenceSwitch< true, T > +OptionalReferenceSwitch< std::is_reference< armnn::BackendId >::value, armnn::BackendId > +OptionalReferenceSwitch< std::is_reference< armnn::ConstTensor >::value, armnn::ConstTensor > +OptionalReferenceSwitch< std::is_reference< armnn::DebugCallbackFunction >::value, armnn::DebugCallbackFunction > +OptionalReferenceSwitch< std::is_reference< armnn::DynamicQuantizationStrategy >::value, armnn::DynamicQuantizationStrategy > +OptionalReferenceSwitch< std::is_reference< armnn::LogSeverity >::value, armnn::LogSeverity > +OptionalReferenceSwitch< std::is_reference< armnn::profiling::IReportStructure & >::value, armnn::profiling::IReportStructure & > +OptionalReferenceSwitch< std::is_reference< armnn::profiling::ProfilingService & >::value, armnn::profiling::ProfilingService & > +OptionalReferenceSwitch< std::is_reference< armnnTfLiteParser::ITfLiteParser::TfLiteParserOptions >::value, armnnTfLiteParser::ITfLiteParser::TfLiteParserOptions > +OptionalReferenceSwitch< std::is_reference< BackendProfilingContexts >::value, BackendProfilingContexts > +OptionalReferenceSwitch< std::is_reference< fs::path >::value, fs::path > +OptionalReferenceSwitch< std::is_reference< int32_t >::value, int32_t > +OptionalReferenceSwitch< std::is_reference< std::string >::value, std::string > +OptionalReferenceSwitch< std::is_reference< T >::value, T > +OptionalReferenceSwitch< std::is_reference< unsigned int >::value, unsigned int > + +
+ + + + + + + + + +

+Public Member Functions

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

+Protected Member Functions

 OptionalBase (bool hasValue) noexcept
 
+ + + +

+Protected Attributes

bool m_HasValue
 
+

Detailed Description

+

OptionalBase is the common functionality between reference and non-reference optional types.

+ +

Definition at line 45 of file Optional.hpp.

+

Constructor & Destructor Documentation

+ +

◆ OptionalBase() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
OptionalBase ()
+ 		+inlinenoexcept
+
+ +

Definition at line 48 of file Optional.hpp.

+
49  : m_HasValue{false}
50  {
51  }
+
+
+
+ +

◆ OptionalBase() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
OptionalBase (bool hasValue)
+ 		+inlineprotectednoexcept
+
+ +

Definition at line 67 of file Optional.hpp.

+
68  : m_HasValue{hasValue}
69  {
70  }
+
+
+
+

Member Function Documentation

+ +

◆ has_value()

+ +
+
+ + + + + +
+ + + + + + + +
bool has_value () const
+ 		+inlinenoexcept
+
+ +

Definition at line 53 of file Optional.hpp.

+ +

Referenced by NetworkImpl::AddConcatLayer(), NetworkImpl::AddConvolution2dLayer(), NetworkImpl::AddFillLayer(), NetworkImpl::AddTransposeConvolution2dLayer(), BOOST_AUTO_TEST_CASE(), TestLayerVisitor::CheckOptionalConstTensors(), CounterDirectory::Clear(), QuantizerStrategy::ExecuteStrategy(), armnn::GetBiasDataType(), armnn::GetInputTensorInfo(), RefLayerSupport::IsConvolution2dSupported(), RefLayerSupport::IsDepthwiseConvolutionSupported(), DelegateOptions::IsLoggingEnabled(), RefLayerSupport::IsTransposeConvolution2dSupported(), ConnectionAcknowledgedCommandHandler::operator()(), OptionalReferenceSwitch< std::is_reference< armnn::DebugCallbackFunction >::value, armnn::DebugCallbackFunction >::operator=(), OptionalReferenceSwitch< true, T >::operator=(), Optional< armnn::LogSeverity >::operator==(), PeriodicCounterSelectionCommandHandler::PeriodicCounterSelectionCommandHandler(), PopulateTensorWithData(), PopulateTensorWithDataGeneric(), CounterDirectory::RegisterCounter(), CounterDirectory::RegisterCounterSet(), CounterDirectory::RegisterDevice(), VerifyTimelineEntityBinaryPacketData(), VerifyTimelineEventBinaryPacket(), VerifyTimelineLabelBinaryPacketData(), and VerifyTimelineRelationshipBinaryPacketData().

+
54  {
55  return m_HasValue;
56  }
+
+
+
+ +

◆ operator bool()

+ +
+
+ + + + + +
+ + + + + + + +
operator bool () const
+ 		+inlineexplicitnoexcept
+
+ +

Conversion to bool, so can be used in if-statements and similar contexts expecting a bool.

+

Note this is explicit so that it doesn't get implicitly converted to a bool in unwanted cases, for example "Optional<TypeA> == Optional<TypeB>" should not compile.

+ +

Definition at line 61 of file Optional.hpp.

+
62  {
63  return has_value();
64  }
armnn::OptionalBase::has_value
bool has_value() const noexcept
Definition: Optional.hpp:53
+
+
+
+

Member Data Documentation

+ +

◆ m_HasValue

+ +
+
+ + + + + +
+ + + + +
bool m_HasValue
+ 		+protected
+
+ +

Definition at line 72 of file Optional.hpp.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + -- cgit v1.2.1