NEFFTDigitReverseKernel Class Reference

Interface for the digit reverse operation kernel. More...

#include <NEFFTDigitReverseKernel.h>

Collaboration diagram for NEFFTDigitReverseKernel:

Public Member Functions
const char *	name () const override
	Name of the kernel. More...
	NEFFTDigitReverseKernel ()
	Constructor. More...
	NEFFTDigitReverseKernel (const NEFFTDigitReverseKernel &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
NEFFTDigitReverseKernel &	operator= (const NEFFTDigitReverseKernel &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
	NEFFTDigitReverseKernel (NEFFTDigitReverseKernel &&)=default
	Default Move Constructor. More...
NEFFTDigitReverseKernel &	operator= (NEFFTDigitReverseKernel &&)=default
	Default move assignment operator. More...
	~NEFFTDigitReverseKernel ()=default
	Default destructor. More...
void	configure (const ITensor *input, ITensor *output, const ITensor *idx, const FFTDigitReverseKernelInfo &config)
	Set the input and output tensors. More...
void	run (const Window &window, const ThreadInfo &info) override
	Execute the kernel on the passed window. More...
Public Member Functions inherited from ICPPKernel
virtual	~ICPPKernel ()=default
	Default destructor. More...
virtual void	run_nd (const Window &window, const ThreadInfo &info, const Window &thread_locator)
	legacy compatibility layer for implemantions which do not support thread_locator In these cases we simply narrow the interface down the legacy version More...
virtual void	run_op (ITensorPack &tensors, const Window &window, const ThreadInfo &info)
	Execute the kernel on the passed window. More...
virtual size_t	get_mws (const CPUInfo &platform, size_t thread_count) const
	Return minimum workload size of the relevant kernel. More...
Public Member Functions inherited from IKernel
	IKernel ()
	Constructor. More...
virtual	~IKernel ()=default
	Destructor. More...
virtual bool	is_parallelisable () const
	Indicates whether or not the kernel is parallelisable. More...
virtual BorderSize	border_size () const
	The size of the border for that kernel. More...
const Window &	window () const
	The maximum window the kernel can be executed on. More...
bool	is_window_configured () const
	Function to check if the embedded window of this kernel has been configured. More...

Static Public Member Functions
static Status	validate (const ITensorInfo *input, const ITensorInfo *output, const ITensorInfo *idx, const FFTDigitReverseKernelInfo &config)
	Static function to check if given info will lead to a valid configuration of NEFFTDigitReverseKernel. More...

Additional Inherited Members
Static Public Attributes inherited from ICPPKernel
static constexpr size_t	default_mws = 1

Detailed Description

Interface for the digit reverse operation kernel.

Definition at line 37 of file NEFFTDigitReverseKernel.h.

Constructor & Destructor Documentation

NEFFTDigitReverseKernel() [1/3]

NEFFTDigitReverseKernel

(

)

Constructor.

Definition at line 78 of file NEFFTDigitReverseKernel.cpp.

                                                 : _func(nullptr), _input(nullptr), _output(nullptr), _idx(nullptr)
{
}

NEFFTDigitReverseKernel() [2/3]

NEFFTDigitReverseKernel ( const NEFFTDigitReverseKernel &  )

delete

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

NEFFTDigitReverseKernel() [3/3]

NEFFTDigitReverseKernel ( NEFFTDigitReverseKernel &&  )

default

Default Move Constructor.

~NEFFTDigitReverseKernel()

~NEFFTDigitReverseKernel ( )

default

Default destructor.

Member Function Documentation

configure()

void configure	(	const ITensor *	input,
		ITensor *	output,
		const ITensor *	idx,
		const FFTDigitReverseKernelInfo &	config
	)

Set the input and output tensors.

Parameters

[in]	input	Source tensor. Data types supported: F32. Number of channels supported: 1 (real tensor) or 2 (complex tensor).
[out]	output	Destination tensor. Data type supported: same as input. Number of channels supported: 2 (complex tensor).
[in]	idx	Digit reverse index tensor. Data type supported: U32
[in]	config	Kernel configuration.

Definition at line 82 of file NEFFTDigitReverseKernel.cpp.

{
    ARM_COMPUTE_ERROR_ON_NULLPTR(input, output, idx);
    ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), idx->info(), config));
 
    _input  = input;
    _output = output;
    _idx    = idx;
 
    const size_t axis             = config.axis;
    const bool   is_conj          = config.conjugate;
    const bool   is_input_complex = (input->info()->num_channels() == 2);
 
    // Configure kernel window
    auto win_config = validate_and_configure_window(input->info(), output->info(), idx->info(), config);
    ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
    INEKernel::configure(win_config.second);
 
    if (axis == 0)
    {
        if (is_input_complex)
        {
            if (is_conj)
            {
                _func = &NEFFTDigitReverseKernel::digit_reverse_kernel_axis_0<true, true>;
            }
            else
            {
                _func = &NEFFTDigitReverseKernel::digit_reverse_kernel_axis_0<true, false>;
            }
        }
        else
        {
            _func = &NEFFTDigitReverseKernel::digit_reverse_kernel_axis_0<false, false>;
        }
    }
    else if (axis == 1)
    {
        if (is_input_complex)
        {
            if (is_conj)
            {
                _func = &NEFFTDigitReverseKernel::digit_reverse_kernel_axis_1<true, true>;
            }
            else
            {
                _func = &NEFFTDigitReverseKernel::digit_reverse_kernel_axis_1<true, false>;
            }
        }
        else
        {
            _func = &NEFFTDigitReverseKernel::digit_reverse_kernel_axis_1<false, false>;
        }
    }
    else
    {
        ARM_COMPUTE_ERROR("Not supported");
    }
}

References ARM_COMPUTE_ERROR, ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, FFTDigitReverseKernelInfo::axis, FFTDigitReverseKernelInfo::conjugate, ITensor::info(), arm_compute::test::validation::input, arm_compute::cpu::kernels::validate_and_configure_window(), and arm_compute::cpu::kernels::validate_arguments().

name()

const char* name ( ) const

inlineoverridevirtual

Name of the kernel.

Returns

Kernel name

Implements ICPPKernel.

Definition at line 40 of file NEFFTDigitReverseKernel.h.

    {
        return "NEFFTDigitReverseKernel";
    }

operator=() [1/2]

NEFFTDigitReverseKernel& operator= ( const NEFFTDigitReverseKernel &  )

delete

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

operator=() [2/2]

NEFFTDigitReverseKernel& operator= ( NEFFTDigitReverseKernel &&  )

default

Default move assignment operator.

run()

void run ( const Window &  window, const ThreadInfo &  info  )

overridevirtual

Execute the kernel on the passed window.

Warning

If is_parallelisable() returns false then the passed window must be equal to window()

Note

The window has to be a region within the window returned by the window() method

The width of the window has to be a multiple of num_elems_processed_per_iteration().

Parameters

[in]	window	Region on which to execute the kernel. (Must be a region of the window returned by window())
[in]	info	Info about executing thread and CPU.

Reimplemented from ICPPKernel.

Definition at line 270 of file NEFFTDigitReverseKernel.cpp.

{
    ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this);
    ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(INEKernel::window(), window);
    ARM_COMPUTE_UNUSED(info);
    (this->*_func)(window);
}

References ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, ARM_COMPUTE_UNUSED, arm_compute::test::validation::info, and IKernel::window().

validate()

Status validate ( const ITensorInfo *  input, const ITensorInfo *  output, const ITensorInfo *  idx, const FFTDigitReverseKernelInfo &  config  )

static

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

Parameters

[in]	input	Source tensor info. Data types supported: F32. Number of channels supported: 1 (real tensor) or 2 (complex tensor).
[in]	output	Destination tensor info. Data type supported: same as input. Number of channels supported: 2 (complex tensor).
[in]	idx	Digit reverse index tensor info. Data type supported: U32
[in]	config	Kernel configuration

Returns

a status

Definition at line 145 of file NEFFTDigitReverseKernel.cpp.

{
    ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, output, idx, config));
    ARM_COMPUTE_RETURN_ON_ERROR(
        validate_and_configure_window(input->clone().get(), output->clone().get(), idx->clone().get(), config).first);
    return Status{};
}

References ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), arm_compute::test::validation::input, arm_compute::cpu::kernels::validate_and_configure_window(), and arm_compute::cpu::kernels::validate_arguments().

---

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

• src/core/NEON/kernels/NEFFTDigitReverseKernel.h
• src/core/NEON/kernels/NEFFTDigitReverseKernel.cpp