ValidRegion Struct Reference

Container for valid region of a window. More...

#include <Types.h>

Collaboration diagram for ValidRegion:

Public Member Functions
	ValidRegion ()
	Default constructor. More...
	ValidRegion (const ValidRegion &)=default
	Allow instances of this class to be copy constructed. More...
	ValidRegion (ValidRegion &&)=default
	Allow instances of this class to be move constructed. More...
ValidRegion &	operator= (const ValidRegion &)=default
	Allow instances of this class to be copied. More...
ValidRegion &	operator= (ValidRegion &&)=default
	Allow instances of this class to be moved. More...
	~ValidRegion ()=default
	Default destructor. More...
	ValidRegion (const Coordinates &an_anchor, const TensorShape &a_shape)
	Constructor for a valid region with default number of dimensions. More...
	ValidRegion (const Coordinates &an_anchor, const TensorShape &a_shape, size_t num_dimensions)
	Constructor for a valid region with specified number of dimensions. More...
int	start (unsigned int d) const
	Return the start of the valid region for the given dimension d. More...
int	end (unsigned int d) const
	Return the end of the valid region for the given dimension d. More...
ValidRegion &	set (size_t dimension, int start, size_t size)
	Accessor to set the value of anchor and shape for one of the dimensions. More...

Data Fields
Coordinates	anchor
	Anchor for the start of the valid region. More...
TensorShape	shape
	Shape of the valid region. More...

Friends
bool	operator== (const ValidRegion &lhs, const ValidRegion &rhs)
	Check whether two valid regions are equal. More...

Detailed Description

Container for valid region of a window.

Definition at line 144 of file Types.h.

Constructor & Destructor Documentation

ValidRegion() [1/5]

ValidRegion ( )

inline

Default constructor.

Definition at line 147 of file Types.h.

        : anchor{}, shape{}
    {
    }

ValidRegion() [2/5]

ValidRegion ( const ValidRegion &  )

default

Allow instances of this class to be copy constructed.

ValidRegion() [3/5]

ValidRegion ( ValidRegion &&  )

default

Allow instances of this class to be move constructed.

~ValidRegion()

~ValidRegion ( )

default

Default destructor.

ValidRegion() [4/5]

ValidRegion ( const Coordinates &  an_anchor, const TensorShape &  a_shape  )

inline

Constructor for a valid region with default number of dimensions.

Parameters

[in]	an_anchor	Anchor for the start of the valid region.
[in]	a_shape	Shape of the valid region.

Definition at line 169 of file Types.h.

        : anchor{ an_anchor }, shape{ a_shape }
    {
        anchor.set_num_dimensions(std::max(anchor.num_dimensions(), shape.num_dimensions()));
    }

ValidRegion() [5/5]

ValidRegion ( const Coordinates &  an_anchor, const TensorShape &  a_shape, size_t  num_dimensions  )

inline

Constructor for a valid region with specified number of dimensions.

Parameters

[in]	an_anchor	Anchor for the start of the valid region.
[in]	a_shape	Shape of the valid region.
[in]	num_dimensions	Number of dimensions (must be >= number of dimensions of anchor and shape).

Definition at line 182 of file Types.h.

        : anchor{ an_anchor }, shape{ a_shape }
    {
        ARM_COMPUTE_ERROR_ON(num_dimensions < std::max(anchor.num_dimensions(), shape.num_dimensions()));
        anchor.set_num_dimensions(num_dimensions);
    }

Member Function Documentation

end()

int end ( unsigned int  d ) const

inline

Return the end of the valid region for the given dimension d.

Definition at line 196 of file Types.h.

    {
        return anchor[d] + shape[d];
    }

References ValidRegion::anchor, and ValidRegion::shape.

Referenced by arm_compute::test::is_in_valid_region().

operator=() [1/2]

ValidRegion& operator= ( const ValidRegion &  )

default

Allow instances of this class to be copied.

operator=() [2/2]

ValidRegion& operator= ( ValidRegion &&  )

default

Allow instances of this class to be moved.

set()

ValidRegion& set ( size_t  dimension, int  start, size_t  size  )

inline

Accessor to set the value of anchor and shape for one of the dimensions.

Parameters

[in]	dimension	Dimension for which the value is set.
[in]	start	Value to be set in anchor for the dimension.
[in]	size	Value to be set in shape for the dimension.

Returns

*this.

Definition at line 209 of file Types.h.

    {
        anchor.set(dimension, start);
        shape.set(dimension, size);
        return *this;
    }

References ValidRegion::anchor, Dimensions< T >::set(), TensorShape::set(), ValidRegion::shape, and ValidRegion::start().

start()

int start ( unsigned int  d ) const

inline

Return the start of the valid region for the given dimension d.

Definition at line 190 of file Types.h.

    {
        return anchor[d];
    }

References ValidRegion::anchor.

Referenced by arm_compute::test::is_in_valid_region(), and ValidRegion::set().

Friends And Related Function Documentation

operator==

bool operator== ( const ValidRegion &  lhs, const ValidRegion &  rhs  )

friend

Check whether two valid regions are equal.

Parameters

[in]	lhs	LHS valid region
[in]	rhs	RHS valid region

Returns

True if the valid regions are the same.

Definition at line 228 of file Types.h.

{
    return (lhs.anchor == rhs.anchor) && (lhs.shape == rhs.shape);
}

Field Documentation

anchor

Coordinates anchor

Anchor for the start of the valid region.

Definition at line 225 of file Types.h.

Referenced by arm_compute::calculate_max_enlarged_window(), arm_compute::calculate_max_window(), arm_compute::calculate_max_window_horizontal(), arm_compute::calculate_valid_region_scale(), AccessWindowTranspose::compute_valid_region(), AccessWindowStatic::compute_valid_region(), AccessWindowRectangle::compute_valid_region(), ValidRegion::end(), arm_compute::error_on_invalid_subtensor_valid_region(), arm_compute::intersect_valid_regions(), arm_compute::cpu::neon_softmax_logits_1d_float(), arm_compute::cpu::neon_softmax_logits_1d_quantized(), arm_compute::operator==(), ValidRegion::set(), arm_compute::test::shape_to_valid_region(), ValidRegion::start(), arm_compute::cpu::sve2_softmax_logits_1d_quantized(), arm_compute::cpu::sve_softmax_logits_1d_float(), and arm_compute::test::validation::validate().

shape

TensorShape shape

Shape of the valid region.

Definition at line 226 of file Types.h.

Referenced by arm_compute::calculate_max_enlarged_window(), arm_compute::calculate_max_window(), arm_compute::calculate_max_window_horizontal(), arm_compute::calculate_valid_region_scale(), AccessWindowTranspose::compute_valid_region(), AccessWindowStatic::compute_valid_region(), AccessWindowRectangle::compute_valid_region(), ValidRegion::end(), arm_compute::error_on_invalid_subtensor_valid_region(), arm_compute::intersect_valid_regions(), arm_compute::cpu::neon_softmax_logits_1d_float(), arm_compute::cpu::neon_softmax_logits_1d_quantized(), arm_compute::operator==(), ValidRegion::set(), arm_compute::test::shape_to_valid_region(), arm_compute::cpu::sve2_softmax_logits_1d_quantized(), arm_compute::cpu::sve_softmax_logits_1d_float(), and arm_compute::test::validation::validate().

---

The documentation for this struct was generated from the following file:

• arm_compute/core/Types.h