NEMatMul Class Reference

Basic function to run the following operators: More...

#include <NEMatMul.h>

Collaboration diagram for NEMatMul:

Public Member Functions
	NEMatMul ()
	Constructor. More...
	~NEMatMul ()
	Destructor. More...
	NEMatMul (const NEMatMul &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
	NEMatMul (NEMatMul &&)=default
	Default move constructor. More...
NEMatMul &	operator= (const NEMatMul &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
NEMatMul &	operator= (NEMatMul &&)=default
	Default move assignment operator. More...
void	configure (ITensor *lhs, ITensor *rhs, ITensor *dst, const MatMulInfo &info, const CpuMatMulSettings &settings, const ActivationLayerInfo &act_info=ActivationLayerInfo())
	Initialize. More...
void	run () override
	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...

Static Public Member Functions
static Status	validate (const ITensorInfo *lhs, const ITensorInfo *rhs, const ITensorInfo *dst, const MatMulInfo &info, const CpuMatMulSettings &settings, const ActivationLayerInfo &act_info=ActivationLayerInfo())
	Static function to check if given info will lead to a valid configuration of NEMatMul. More...

Detailed Description

Basic function to run the following operators:

1. cpu::CpuMatMul

Definition at line 77 of file NEMatMul.h.

Constructor & Destructor Documentation

NEMatMul() [1/3]

NEMatMul

(

)

Constructor.

Definition at line 46 of file NEMatMul.cpp.

                   : _impl(std::make_unique<Impl>())
{
}

~NEMatMul()

~NEMatMul ( )

default

Destructor.

NEMatMul() [2/3]

NEMatMul ( const NEMatMul &  )

delete

Prevent instances of this class from being copied (As this class contains pointers)

NEMatMul() [3/3]

NEMatMul ( NEMatMul &&  )

default

Default move constructor.

Member Function Documentation

configure()

void configure	(	ITensor *	lhs,
		ITensor *	rhs,
		ITensor *	dst,
		const MatMulInfo &	info,
		const CpuMatMulSettings &	settings,
		const ActivationLayerInfo &	act_info = ActivationLayerInfo()
	)

Initialize.

Valid data layouts:

• Any

Valid data type configurations:

lhs	rhs	dst
F32	F32	F32
F16	F16	F16
BFLOAT16	BFLOAT16	BFLOAT16
QASYMM8_SIGNED	QASYMM8_SIGNED	QASYMM8_SIGNED
QASYMM8	QASYMM8	QASYMM8

Parameters

[in]	lhs	Left-hand side tensor info. Data types supported: F16/F32/QASYMM8_SIGNED/QASYMM8.
[in]	rhs	Right-hand side tensor info. Data types supported: same as lhs.
[out]	dst	Output tensor to store the result of the batched matrix multiplication. Data types supported: same as lhs / rhs.
[in]	info	Contains MatMul operation information described in MatMulInfo.
[in]	settings	Contains flags for function level settings i.e fast math
[in]	act_info	(Optional) Contains activation function and lower and upper bound values for bounded activation functions.

Definition at line 52 of file NEMatMul.cpp.

{
    _impl->lhs    = lhs;
    _impl->rhs    = rhs;
    _impl->output = output;
 
    ARM_COMPUTE_ERROR_ON_NULLPTR(_impl->lhs, _impl->rhs, _impl->output);
    _impl->op = std::make_unique<cpu::CpuMatMul>();
    _impl->op->configure(lhs->info(), rhs->info(), output->info(), info, settings, act_info);
    _impl->run_pack          = {{ACL_SRC_0, lhs}, {ACL_SRC_1, rhs}, {ACL_DST, output}};
    _impl->workspace_tensors = manage_workspace<Tensor>(_impl->op->workspace(), _impl->memory_group, _impl->run_pack);
}

References arm_compute::ACL_DST, arm_compute::ACL_SRC_0, arm_compute::ACL_SRC_1, arm_compute::test::validation::act_info, ARM_COMPUTE_ERROR_ON_NULLPTR, ITensor::info(), and arm_compute::test::validation::info.

operator=() [1/2]

NEMatMul& operator= ( const NEMatMul &  )

delete

Prevent instances of this class from being copied (As this class contains pointers)

operator=() [2/2]

NEMatMul& operator= ( NEMatMul &&  )

default

Default move assignment operator.

run()

void run ( )

overridevirtual

Run the kernels contained in the function.

For CPU kernels:

• Multi-threading is used for the kernels which are parallelisable.
• By default std::thread::hardware_concurrency() threads are used.

Note

CPPScheduler::set_num_threads() can be used to manually set the number of threads

For OpenCL kernels:

• All the kernels are enqueued on the queue associated with CLScheduler.
• The queue is then flushed.

Note

The function will not block until the kernels are executed. It is the user's responsibility to wait.

Will call prepare() on first run if hasn't been done

Implements IFunction.

Definition at line 80 of file NEMatMul.cpp.

{
    MemoryGroupResourceScope scope_mg(_impl->memory_group);
    _impl->op->run(_impl->run_pack);
}

validate()

Status validate ( const ITensorInfo *  lhs, const ITensorInfo *  rhs, const ITensorInfo *  dst, const MatMulInfo &  info, const CpuMatMulSettings &  settings, const ActivationLayerInfo &  act_info = ActivationLayerInfo()  )

static

Static function to check if given info will lead to a valid configuration of NEMatMul.

Parameters

[in]	lhs	Left-hand side tensor info. Data types supported: F16/F32/QASYMM8_SIGNED/QASYMM8.
[in]	rhs	Right-hand side tensor info. Data types supported: same as lhs.
[out]	dst	Output tensor info to store the result of the batched matrix multiplication. Data types supported: same as lhs / rhs.
[in]	info	Contains MatMul operation information described in MatMulInfo.
[in]	settings	Contains flags for function level settings i.e fast math
[in]	act_info	(Optional) Contains activation function and lower and upper bound values for bounded activation functions.

Returns

Status

Definition at line 70 of file NEMatMul.cpp.

{
    return cpu::CpuMatMul::validate(lhs, rhs, output, info, settings, act_info);
}

References arm_compute::test::validation::act_info, arm_compute::test::validation::info, and CpuMatMul::validate().

---

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

• arm_compute/runtime/NEON/functions/NEMatMul.h
• src/runtime/NEON/functions/NEMatMul.cpp