Compute Library
 21.02
CLMagnitude Class Reference

Basic function to run CLMagnitudePhaseKernel. More...

#include <CLMagnitude.h>

Collaboration diagram for CLMagnitude:
[legend]

Public Member Functions

void configure (const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, MagnitudeType mag_type=MagnitudeType::L2NORM)
 Initialise the kernel's inputs. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, MagnitudeType mag_type=MagnitudeType::L2NORM)
 Initialise the kernel's inputs. More...
 
- Public Member Functions inherited from ICLSimpleFunction
 ICLSimpleFunction (CLRuntimeContext *ctx=nullptr)
 Constructor. More...
 
 ICLSimpleFunction (const ICLSimpleFunction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 ICLSimpleFunction (ICLSimpleFunction &&)=default
 Default move constructor. More...
 
ICLSimpleFunctionoperator= (const ICLSimpleFunction &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
ICLSimpleFunctionoperator= (ICLSimpleFunction &&)=default
 Default move assignment operator. More...
 
 ~ICLSimpleFunction ()
 Default destructor. More...
 
void run () override final
 Run the kernels contained in the function. More...
 
- Public Member Functions inherited from IFunction
virtual ~IFunction ()=default
 Destructor. More...
 
virtual void prepare ()
 Prepare the function for executing. More...
 

Detailed Description

Basic function to run CLMagnitudePhaseKernel.

Deprecated:
This function is deprecated and is intended to be removed in 21.05 release

Definition at line 40 of file CLMagnitude.h.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor input1,
const ICLTensor input2,
ICLTensor output,
MagnitudeType  mag_type = MagnitudeType::L2NORM 
)

Initialise the kernel's inputs.

Parameters
[in]input1First tensor input. Data types supported: S16.
[in]input2Second tensor input. Data types supported: S16.
[out]outputOutput tensor. Data types supported: S16.
[in]mag_type(Optional) Magnitude calculation type. Default: L2NORM.

Definition at line 32 of file CLMagnitude.cpp.

References CLKernelLibrary::get().

33 {
34  configure(CLKernelLibrary::get().get_compile_context(), input1, input2, output, mag_type);
35 }
void configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, MagnitudeType mag_type=MagnitudeType::L2NORM)
Initialise the kernel&#39;s inputs.
Definition: CLMagnitude.cpp:32
static CLKernelLibrary & get()
Access the KernelLibrary singleton.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input1,
const ICLTensor input2,
ICLTensor output,
MagnitudeType  mag_type = MagnitudeType::L2NORM 
)

Initialise the kernel's inputs.

Parameters
[in]compile_contextThe compile context to be used.
[in]input1First tensor input. Data types supported: S16.
[in]input2Second tensor input. Data types supported: S16.
[out]outputOutput tensor. Data types supported: S16.
[in]mag_type(Optional) Magnitude calculation type. Default: L2NORM.

Definition at line 37 of file CLMagnitude.cpp.

38 {
39  auto k = std::make_unique<CLMagnitudePhaseKernel>();
40  k->configure(compile_context, input1, input2, output, nullptr, mag_type);
41  _kernel = std::move(k);
42 }

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