IOFormatInfo Struct Reference

IO formatting information class. More...

#include <Types.h>

Public Types
enum	PrecisionType { Default, Custom, Full }
	Precision type used when printing floating point numbers. More...
enum	PrintRegion { ValidRegion, NoPadding, Full }
	Specifies the area to be printed, used by Tensor objects. More...

Public Member Functions
	IOFormatInfo (PrintRegion print_region=PrintRegion::ValidRegion, PrecisionType precision_type=PrecisionType::Default, unsigned int precision=10, bool align_columns=true, std::string element_delim=" ", std::string row_delim="\n")
	Construct a set of IO formatting information. More...

Data Fields
PrintRegion	print_region
	Area to be printed by Tensor objects. More...
PrecisionType	precision_type
	Floating point precision type. More...
unsigned int	precision
	Floating point precision. More...
std::string	element_delim
	Element delimeter. More...
std::string	row_delim
	Row delimeter. More...
bool	align_columns
	Align columns. More...

Detailed Description

IO formatting information class.

Definition at line 1859 of file Types.h.

Member Enumeration Documentation

PrecisionType

enum PrecisionType

strong

Precision type used when printing floating point numbers.

Enumerator
Default	Default precision to the one that the current stream has.
Custom	Custom precision specified by the user using the precision parameter.
Full	The maximum precision of the floating point representation.

Definition at line 1862 of file Types.h.

    {
        Default, /**< Default precision to the one that the current stream has */
        Custom,  /**< Custom precision specified by the user using the precision parameter */
        Full     /**< The maximum precision of the floating point representation */
    };

PrintRegion

enum PrintRegion

strong

Specifies the area to be printed, used by Tensor objects.

Enumerator
ValidRegion	Prints the valid region of the Tensor object.
NoPadding	Prints the Tensor object without the padding.
Full	Print the tensor object including padding.

Definition at line 1870 of file Types.h.

    {
        ValidRegion, /**< Prints the valid region of the Tensor object */
        NoPadding,   /**< Prints the Tensor object without the padding */
        Full         /**< Print the tensor object including padding */
    };

Constructor & Destructor Documentation

IOFormatInfo()

IOFormatInfo ( PrintRegion  print_region = PrintRegion::ValidRegion, PrecisionType  precision_type = PrecisionType::Default, unsigned int  precision = 10, bool  align_columns = true, std::string  element_delim = " ", std::string  row_delim = "\n"  )

inline

Construct a set of IO formatting information.

Parameters

[in]	print_region	Area to be printed. Used by Tensor objects. Default: ValidRegion.
[in]	precision_type	Precision type for floating point numbers. Default: stream default.
[in]	precision	Precision value for float point numbers. Default: 10.
[in]	align_columns	Whether to align columns when printed. Default: true.
[in]	element_delim	Delimeter between elements. Default: " ".
[in]	row_delim	Delimenter between rows. Default: "\n".

Definition at line 1886 of file Types.h.

        : print_region(print_region),
          precision_type(precision_type),
          precision(precision),
          element_delim(element_delim),
          row_delim(row_delim),
          align_columns(align_columns)
    {
    }

Field Documentation

align_columns

bool align_columns

Align columns.

Definition at line 1912 of file Types.h.

element_delim

std::string element_delim

Element delimeter.

Definition at line 1908 of file Types.h.

precision

unsigned int precision

Floating point precision.

Definition at line 1906 of file Types.h.

precision_type

PrecisionType precision_type

Floating point precision type.

Definition at line 1904 of file Types.h.

print_region

PrintRegion print_region

Area to be printed by Tensor objects.

Definition at line 1902 of file Types.h.

row_delim

std::string row_delim

Row delimeter.

Definition at line 1910 of file Types.h.

---

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

• arm_compute/core/Types.h