X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=documentation%2Fstructarm__compute_1_1_valid_region.xhtml;h=77a424b9d14bd7e58d76019dee7481f1e9171775;hb=b3a371bc429d2ba45e56baaf239d8200c2662a74;hp=cbc14740d6db6e272ba25df0aba773858755e551;hpb=46d5927c3461ec270de8b0fc087ac5dc2431488f;p=platform%2Fupstream%2Farmcl.git diff --git a/documentation/structarm__compute_1_1_valid_region.xhtml b/documentation/structarm__compute_1_1_valid_region.xhtml index cbc1474..77a424b 100644 --- a/documentation/structarm__compute_1_1_valid_region.xhtml +++ b/documentation/structarm__compute_1_1_valid_region.xhtml @@ -6,7 +6,7 @@ -ARM Compute Library: ValidRegion Struct Reference +Compute Library: ValidRegion Struct Reference @@ -39,8 +39,8 @@ -
ARM Compute Library -  17.05 +
Compute Library +  18.05
@@ -55,6 +55,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
-

#include <Types.h>

+

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

+ +

#include <Types.h>

Collaboration diagram for ValidRegion:
-
+
[legend]
+ + + + + + - - + + + + + + + + +

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 (Coordinates anchor, TensorShape shape)
 
 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...
 

Detailed Description

-
-

Definition at line 86 of file Types.h.

+

Container for valid region of a window.

+ +

Definition at line 206 of file Types.h.

Constructor & Destructor Documentation

@@ -185,9 +205,13 @@ Data Fields
-

Definition at line 88 of file Types.h.

-
89  : anchor{}, shape{}
90  {
91  }
arm_compute::ValidRegion::shape
TensorShape shape
Definition: Types.h:117
-
arm_compute::ValidRegion::anchor
Coordinates anchor
Definition: Types.h:116
+

Default constructor.

+ +

Definition at line 209 of file Types.h.

+ +

References arm_compute::test::validation::shape.

+
210  : anchor{}, shape{}
211  {
212  }
arm_compute::ValidRegion::shape
TensorShape shape
Shape of the valid region.
Definition: Types.h:279
+
arm_compute::ValidRegion::anchor
Coordinates anchor
Anchor for the start of the valid region.
Definition: Types.h:278
@@ -213,6 +237,8 @@ Data Fields
+

Allow instances of this class to be copy constructed.

+
@@ -237,6 +263,8 @@ Data Fields
+

Allow instances of this class to be move constructed.

+
@@ -260,9 +288,63 @@ Data Fields
+

Default destructor.

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

Constructor for a valid region with default number of dimensions.

+
Parameters
+ + + +
[in]an_anchorAnchor for the start of the valid region.
[in]a_shapeShape of the valid region.
+
+
+ +

Definition at line 231 of file Types.h.

+ +

References arm_compute::test::fixed_point_arithmetic::detail::max(), and arm_compute::test::validation::shape.

+
232  : anchor{ an_anchor }, shape{ a_shape }
233  {
234  anchor.set_num_dimensions(std::max(anchor.num_dimensions(), shape.num_dimensions()));
235  }
arm_compute::ValidRegion::shape
TensorShape shape
Shape of the valid region.
Definition: Types.h:279
+
arm_compute::Dimensions::num_dimensions
unsigned int num_dimensions() const
Returns the effective dimensionality of the tensor.
Definition: Dimensions.h:122
+
arm_compute::test::fixed_point_arithmetic::detail::max
fixed_point< T > max(fixed_point< T > x, fixed_point< T > y)
Definition: FixedPoint.h:902
+
arm_compute::Dimensions::set_num_dimensions
void set_num_dimensions(size_t num_dimensions)
Set number of dimensions.
Definition: Dimensions.h:128
+
arm_compute::ValidRegion::anchor
Coordinates anchor
Anchor for the start of the valid region.
Definition: Types.h:278
+
- +
@@ -272,14 +354,20 @@ Data Fields - - + + - - + + + + + + + + @@ -294,9 +382,25 @@ Data Fields
ValidRegion (Coordinates anchor, const Coordinates & an_anchor,
TensorShape shape const TensorShape & a_shape,
size_t num_dimensions 
-

Definition at line 99 of file Types.h.

-
100  : anchor{ anchor }, shape{ shape }
101  {
102  }
arm_compute::ValidRegion::shape
TensorShape shape
Definition: Types.h:117
-
arm_compute::ValidRegion::anchor
Coordinates anchor
Definition: Types.h:116
+

Constructor for a valid region with specified number of dimensions.

+
Parameters
+ + + + +
[in]an_anchorAnchor for the start of the valid region.
[in]a_shapeShape of the valid region.
[in]num_dimensionsNumber of dimensions (must be >= number of dimensions of anchor and shape).
+
+
+ +

Definition at line 244 of file Types.h.

+ +

References ARM_COMPUTE_ERROR_ON, arm_compute::test::fixed_point_arithmetic::detail::max(), and arm_compute::test::validation::shape.

+
245  : anchor{ an_anchor }, shape{ a_shape }
246  {
247  ARM_COMPUTE_ERROR_ON(num_dimensions < std::max(anchor.num_dimensions(), shape.num_dimensions()));
248  anchor.set_num_dimensions(num_dimensions);
249  }
arm_compute::ValidRegion::shape
TensorShape shape
Shape of the valid region.
Definition: Types.h:279
+
ARM_COMPUTE_ERROR_ON
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:328
+
arm_compute::Dimensions::num_dimensions
unsigned int num_dimensions() const
Returns the effective dimensionality of the tensor.
Definition: Dimensions.h:122
+
arm_compute::test::fixed_point_arithmetic::detail::max
fixed_point< T > max(fixed_point< T > x, fixed_point< T > y)
Definition: FixedPoint.h:902
+
arm_compute::Dimensions::set_num_dimensions
void set_num_dimensions(size_t num_dimensions)
Set number of dimensions.
Definition: Dimensions.h:128
+
arm_compute::ValidRegion::anchor
Coordinates anchor
Anchor for the start of the valid region.
Definition: Types.h:278
@@ -325,9 +429,13 @@ Data Fields

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

-

Definition at line 111 of file Types.h.

-
112  {
113  return anchor[d] + shape[d];
114  }
arm_compute::ValidRegion::shape
TensorShape shape
Definition: Types.h:117
-
arm_compute::ValidRegion::anchor
Coordinates anchor
Definition: Types.h:116
+

Definition at line 258 of file Types.h.

+ +

References arm_compute::test::validation::shape.

+ +

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

+
259  {
260  return anchor[d] + shape[d];
261  }
arm_compute::ValidRegion::shape
TensorShape shape
Shape of the valid region.
Definition: Types.h:279
+
arm_compute::ValidRegion::anchor
Coordinates anchor
Anchor for the start of the valid region.
Definition: Types.h:278
@@ -353,6 +461,8 @@ Data Fields
+

Allow instances of this class to be copied.

+
@@ -377,6 +487,70 @@ Data Fields
+

Allow instances of this class to be moved.

+ +
+ + +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
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]dimensionDimension for which the value is set.
[in]startValue to be set in anchor for the dimension.
[in]sizeValue to be set in shape for the dimension.
+
+
+
Returns
*this.
+ +

Definition at line 271 of file Types.h.

+ +

References ValidRegion::set(), and arm_compute::test::validation::shape.

+ +

Referenced by ValidRegion::set().

+
272  {
273  anchor.set(dimension, start);
274  shape.set(dimension, size);
275  return *this;
276  }
arm_compute::ValidRegion::shape
TensorShape shape
Shape of the valid region.
Definition: Types.h:279
+
arm_compute::Dimensions::set
void set(size_t dimension, T value)
Accessor to set the value of one of the dimensions.
Definition: Dimensions.h:74
+
arm_compute::ValidRegion::start
int start(unsigned int d) const
Return the start of the valid region for the given dimension d.
Definition: Types.h:252
+
arm_compute::TensorShape::set
TensorShape & set(size_t dimension, size_t value, bool apply_dim_correction=true)
Accessor to set the value of one of the dimensions.
Definition: TensorShape.h:78
+
arm_compute::ValidRegion::anchor
Coordinates anchor
Anchor for the start of the valid region.
Definition: Types.h:278
+
@@ -403,8 +577,10 @@ Data Fields

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

-

Definition at line 105 of file Types.h.

-
106  {
107  return anchor[d];
108  }
arm_compute::ValidRegion::anchor
Coordinates anchor
Definition: Types.h:116
+

Definition at line 252 of file Types.h.

+ +

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

+
253  {
254  return anchor[d];
255  }
arm_compute::ValidRegion::anchor
Coordinates anchor
Anchor for the start of the valid region.
Definition: Types.h:278
@@ -419,9 +595,11 @@ Data Fields
-

Definition at line 116 of file Types.h.

+

Anchor for the start of the valid region.

-

Referenced by arm_compute::intersect_valid_regions().

+

Definition at line 278 of file Types.h.

+ +

Referenced by arm_compute::intersect_valid_regions(), arm_compute::test::shape_to_valid_region_gaussian_pyramid_half(), and arm_compute::test::validation::validate().

@@ -435,14 +613,16 @@ Data Fields
-

Definition at line 117 of file Types.h.

+

Shape of the valid region.

+ +

Definition at line 279 of file Types.h.

-

Referenced by arm_compute::intersect_valid_regions().

+

Referenced by arm_compute::intersect_valid_regions(), arm_compute::test::shape_to_valid_region_gaussian_pyramid_half(), and arm_compute::test::validation::validate().

The documentation for this struct was generated from the following file: @@ -450,7 +630,7 @@ Data Fields