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_dynamic_backend.xhtml | 301 +++++++++++++++++++++++++++++ 1 file changed, 301 insertions(+) create mode 100644 21.02/classarmnn_1_1_dynamic_backend.xhtml (limited to '21.02/classarmnn_1_1_dynamic_backend.xhtml') diff --git a/21.02/classarmnn_1_1_dynamic_backend.xhtml b/21.02/classarmnn_1_1_dynamic_backend.xhtml new file mode 100644 index 0000000000..0c0a0fcb71 --- /dev/null +++ b/21.02/classarmnn_1_1_dynamic_backend.xhtml @@ -0,0 +1,301 @@ + + + + + + + + + + + + + +ArmNN: DynamicBackend Class Reference + + + + + + + + + + + + + + + + +
+
+ + + + ArmNN + + + +
+
+  21.02 +
+
+
+ + + + + + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Public Types | +Public Member Functions | +List of all members
+
+
DynamicBackend Class Referencefinal
+
+
+ +

#include <DynamicBackend.hpp>

+ + + + + + +

+Public Types

using HandleCloser = std::function< void(const void *)>
 
using HandlePtr = std::unique_ptr< void, HandleCloser >
 
+ + + + + + + + + + + + +

+Public Member Functions

 DynamicBackend (const void *sharedObjectHandle)
 
BackendId GetBackendId ()
 Public dynamic backend functions. More...
 
BackendVersion GetBackendVersion ()
 
IBackendInternalUniquePtr GetBackend ()
 
BackendRegistry::FactoryFunction GetFactoryFunction ()
 
+

Detailed Description

+
+

Definition at line 18 of file DynamicBackend.hpp.

+

Member Typedef Documentation

+ +

◆ HandleCloser

+ +
+
+ + + + +
using HandleCloser = std::function<void(const void*)>
+
+ +

Definition at line 21 of file DynamicBackend.hpp.

+ +
+
+ +

◆ HandlePtr

+ +
+
+ + + + +
using HandlePtr = std::unique_ptr<void, HandleCloser>
+
+ +

Definition at line 22 of file DynamicBackend.hpp.

+ +
+
+

Constructor & Destructor Documentation

+ +

◆ DynamicBackend()

+ +
+
+ + + + + +
+ + + + + + + + +
DynamicBackend (const void * sharedObjectHandle)
+ 		+explicit
+
+ +

Definition at line 12 of file DynamicBackend.cpp.

+ +

References IBackendInternal::GetApiVersion(), DynamicBackend::GetBackendId(), DynamicBackend::GetBackendVersion(), and DynamicBackendUtils::IsBackendCompatible().

+
13  : m_BackendIdFunction(nullptr)
14  , m_BackendVersionFunction(nullptr)
15  , m_BackendFactoryFunction(nullptr)
16  , m_Handle(const_cast<void*>(sharedObjectHandle), &DynamicBackendUtils::CloseHandle)
17 {
18  if (m_Handle == nullptr)
19  {
20  throw InvalidArgumentException("Cannot create a DynamicBackend object from an invalid shared object handle");
21  }
22 
23  // These calls will throw in case of error
24  m_BackendIdFunction = SetFunctionPointer<IdFunctionType>("GetBackendId");
25  m_BackendVersionFunction = SetFunctionPointer<VersionFunctionType>("GetVersion");
26  m_BackendFactoryFunction = SetFunctionPointer<FactoryFunctionType>("BackendFactory");
27 
28  // Check that the backend is compatible with the current Backend API
29  BackendId backendId = GetBackendId();
30  BackendVersion backendVersion = GetBackendVersion();
31  if (!DynamicBackendUtils::IsBackendCompatible(backendVersion))
32  {
33  // This exception message could not be formatted simply using fmt::format
34  std::stringstream message;
35  message << "The dynamic backend " << backendId << " (version " << backendVersion <<
36  ") is not compatible with the current Backend API (version " << IBackendInternal::GetApiVersion() << ")";
37 
38  throw RuntimeException(message.str());
39  }
40 }
armnn::DynamicBackendUtils::IsBackendCompatible
static bool IsBackendCompatible(const BackendVersion &backendVersion)
Definition: DynamicBackendUtils.cpp:50
+
armnn::IBackendInternal::GetApiVersion
static constexpr BackendVersion GetApiVersion()
Returns the version of the Backend API.
Definition: IBackendInternal.hpp:166
+
armnn::DynamicBackend::GetBackendId
BackendId GetBackendId()
Public dynamic backend functions.
Definition: DynamicBackend.cpp:42
+
armnn::DynamicBackendUtils::CloseHandle
static void CloseHandle(const void *sharedObjectHandle)
Definition: DynamicBackendUtils.cpp:36
+
armnn::DynamicBackend::GetBackendVersion
BackendVersion GetBackendVersion()
Definition: DynamicBackend.cpp:58
+
+
+
+

Member Function Documentation

+ +

◆ GetBackend()

+ +
+
+ + + + + + + +
IBackendInternalUniquePtr GetBackend ()
+
+ +

Definition at line 72 of file DynamicBackend.cpp.

+
73 {
74  // This call throws in case of error
75  return CreateBackend();
76 }
+
+
+ +

◆ GetBackendId()

+ +
+
+ + + + + + + +
BackendId GetBackendId ()
+
+ +

Public dynamic backend functions.

+ +

Definition at line 42 of file DynamicBackend.cpp.

+ +

Referenced by DynamicBackend::DynamicBackend().

+
43 {
44  if (m_BackendIdFunction == nullptr)
45  {
46  throw RuntimeException("GetBackendId error: invalid function pointer");
47  }
48 
49  const char* backendId = m_BackendIdFunction();
50  if (backendId == nullptr)
51  {
52  throw RuntimeException("GetBackendId error: invalid backend id");
53  }
54 
55  return BackendId(backendId);
56 }
+
+
+ +

◆ GetBackendVersion()

+ +
+
+ + + + + + + +
BackendVersion GetBackendVersion ()
+
+ +

Definition at line 58 of file DynamicBackend.cpp.

+ +

Referenced by DynamicBackend::DynamicBackend().

+
59 {
60  if (m_BackendVersionFunction == nullptr)
61  {
62  throw RuntimeException("GetBackendVersion error: invalid function pointer");
63  }
64 
65  uint32_t major = 0;
66  uint32_t minor = 0;
67  m_BackendVersionFunction(&major, &minor);
68 
69  return BackendVersion{ major, minor };
70 }
+
+
+ +

◆ GetFactoryFunction()

+ +
+
+ + + + + + + +
BackendRegistry::FactoryFunction GetFactoryFunction ()
+
+ +

Definition at line 78 of file DynamicBackend.cpp.

+
79 {
80  if (m_BackendFactoryFunction == nullptr)
81  {
82  throw RuntimeException("GetFactoryFunction error: invalid function pointer");
83  }
84 
85  return [this]() -> IBackendInternalUniquePtr
86  {
87  // This call throws in case of error
88  return CreateBackend();
89  };
90 }
armnn::IBackendInternalUniquePtr
std::unique_ptr< IBackendInternal > IBackendInternalUniquePtr
Definition: BackendRegistry.hpp:23
+
+
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1