NEPermute Class Reference

Basic function to run cpu::kernels::CpuPermuteKernel. More...

#include <NEPermute.h>

Collaboration diagram for NEPermute:

Public Member Functions
	NEPermute ()
	Default Constructor. More...
	~NEPermute ()
	Default Destructor. More...
	NEPermute (const NEPermute &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
	NEPermute (NEPermute &&)=default
	Default move constructor. More...
NEPermute &	operator= (const NEPermute &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
NEPermute &	operator= (NEPermute &&)=default
	Default move assignment operator. More...
void	configure (const ITensor *input, ITensor *output, const PermutationVector &perm)
	Configure the permute function. 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 *input, const ITensorInfo *output, const PermutationVector &perm)
	Static function to check if given info will lead to a valid configuration of NEPermute. More...

Detailed Description

Basic function to run cpu::kernels::CpuPermuteKernel.

Definition at line 40 of file NEPermute.h.

Constructor & Destructor Documentation

NEPermute() [1/3]

NEPermute

(

)

Default Constructor.

Definition at line 38 of file NEPermute.cpp.

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

~NEPermute()

~NEPermute ( )

default

Default Destructor.

NEPermute() [2/3]

NEPermute ( const NEPermute &  )

delete

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

NEPermute() [3/3]

NEPermute ( NEPermute &&  )

default

Default move constructor.

Member Function Documentation

configure()

void configure	(	const ITensor *	input,
		ITensor *	output,
		const PermutationVector &	perm
	)

Configure the permute function.

Valid data layouts:

• NHWC
• NCHW

Valid data type configurations:

src	dst
All	All

Note

Arbitrary permutation vectors are supported with rank not greater than 4

Parameters

[in]	input	The input tensor to permute. Data types supported: All
[out]	output	The output tensor. Data types supported: Same as input
[in]	perm	Permutation vector

Definition at line 45 of file NEPermute.cpp.

{
    ARM_COMPUTE_ERROR_ON_NULLPTR(input, output);

    _impl->src = input;
    _impl->dst = output;
    _impl->op  = std::make_unique<cpu::CpuPermute>();
    _impl->op->configure(input->info(), output->info(), perm);
}

References ARM_COMPUTE_ERROR_ON_NULLPTR, ITensor::info(), and arm_compute::test::validation::input.

Referenced by NEInstanceNormalizationLayer::configure(), NEGEMMConv2d::configure(), NEFFTConvolutionLayer::configure(), and NEGenerateProposalsLayer::configure().

operator=() [1/2]

NEPermute& operator= ( const NEPermute &  )

delete

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

operator=() [2/2]

NEPermute& operator= ( NEPermute &&  )

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 63 of file NEPermute.cpp.

{
    ITensorPack pack;
    pack.add_tensor(TensorType::ACL_SRC, _impl->src);
    pack.add_tensor(TensorType::ACL_DST, _impl->dst);
    _impl->op->run(pack);
}

References arm_compute::ACL_DST, arm_compute::ACL_SRC, and ITensorPack::add_tensor().

Referenced by NEGEMMConv2d::prepare(), NEFFTConvolutionLayer::prepare(), NEInstanceNormalizationLayer::run(), NEFFTConvolutionLayer::run(), and NEGenerateProposalsLayer::run().

validate()

Status validate ( const ITensorInfo *  input, const ITensorInfo *  output, const PermutationVector &  perm  )

static

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

Note

Arbitrary permutation vectors are supported with rank not greater than 4

Parameters

[in]	input	The input tensor to permute. Data types supported: All
[in]	output	The output tensor. Data types supported: Same as input
[in]	perm	Permutation vector

Returns

a status

Definition at line 55 of file NEPermute.cpp.

{
    ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, output);
    ARM_COMPUTE_RETURN_ON_ERROR(cpu::CpuPermute::validate(input, output, perm));

    return Status{};
}

References ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR, ARM_COMPUTE_RETURN_ON_ERROR, arm_compute::test::validation::input, and CpuPermute::validate().

Referenced by NEGenerateProposalsLayer::validate().

---

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

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