#include <layout.h>

Collaboration diagram for nnvm::Layout:

Public Types
using	LayoutDim = char

using	iterator = std::vector< LayoutDim >::const_iterator

using	reverse_iterator = std::vector< LayoutDim >::const_reverse_iterator

Public Member Functions
	Layout ()
	default constructor More...

	Layout (const std::string &layout)
	construct from a string. More...

	Layout (const Layout &s)
	copy constructor from another layout More...

	Layout (Layout &&src)
	move constructor from Layout More...

Layout &	operator= (const Layout &src)
	assignment from another layout. More...

Layout &	operator= (Layout &&src)
	assignment from rvalue of another layout. More...

Layout &	operator= (const std::string &src)
	assignment from string. More...

bool	operator== (const Layout &s) const

bool	operator!= (const Layout &s) const

Layout	operator+ (const Layout &other) const
	Append the current layout by another. More...

void	swap (Layout &other)
	Swap current object with other. More...

bool	convertible (const Layout &dst) const
	Two layouts are convertible only if they have same set of super-dimensions. e.g., NCHW, NCHW16c, NHWC are convertible between each other, but NCHW, CHW, OIHW are not. More...

Layout	sublayout (size_t pos, size_t len) const
	Returns a sublayout which is the portion of the object that starts at dimension `pos` and spans `len` dimensions (or until the end of the layout, whichever comes first). More...

Layout	reverse () const

Layout	split (LayoutDim dim, size_t target_pos, uint32_t size) const
	Split `dim` by `size` and put the sub-dimension to position `target_pos`. More...

iterator	begin () const

iterator	end () const

reverse_iterator	rbegin () const

reverse_iterator	rend () const

size_t	ndim () const

std::string	at (size_t i) const
	The description of the `i-th` dimension. If it is a sub-dimension, the size will be returned as well, e.g., 16c. Otherwise a single character is returned, e.g., C. More...

int32_t	indexof (LayoutDim dim) const
	return the index of the input dimension. If it is not found in the layout or the layout is undefined, return -1. More...

int64_t	subsizeof (LayoutDim dim) const

bool	contains (LayoutDim dim) const
	Whether the layout contains a dimension. More...

LayoutDim	operator[] (size_t i) const

bool	defined () const

const std::string &	name () const

void	Save (dmlc::JSONWriter *writer) const
	Write layout in JSON format. More...

void	Load (dmlc::JSONReader *reader)
	Load layout from JSON. More...

Static Public Member Functions
static bool	is_superdim (LayoutDim dim)
	Check whether a given dimension is a super-dimension. More...

static bool	is_subdim (LayoutDim dim)
	Check whether a given dimension is a sub-dimension. More...

static LayoutDim	to_superdim (LayoutDim dim)
	Convert a given dimension to super-dimension. More...

static LayoutDim	to_subdim (LayoutDim dim)
	Convert a given dimension to sub-dimension. More...

static const Layout &	Undef ()
	Return an undefined layout. More...

Friends
std::ostream &	operator<< (std::ostream &os, const Layout &l)
	allow output string of layout to ostream More...

Member Typedef Documentation

using nnvm::Layout::iterator = std::vector<LayoutDim>::const_iterator

using nnvm::Layout::LayoutDim = char

using nnvm::Layout::reverse_iterator = std::vector<LayoutDim>::const_reverse_iterator

Constructor & Destructor Documentation

nnvm::Layout::Layout ( )

inline

default constructor

nnvm::Layout::Layout ( const std::string & layout )

inline

construct from a string.

Parameters

layout input in layout convention: upper case indicates a dimension and the corresponding lower case with factor size indicates the split dimension. return undefined layout if "__undef__" is passed.

nnvm::Layout::Layout ( const Layout & s )

inline

copy constructor from another layout

Parameters

s	the source layout

nnvm::Layout::Layout ( Layout && src )

inline

move constructor from Layout

Parameters

src	the source layout

Member Function Documentation

std::string nnvm::Layout::at ( size_t i ) const

inline

The description of the i-th dimension. If it is a sub-dimension, the size will be returned as well, e.g., 16c. Otherwise a single character is returned, e.g., C.

Parameters

i	The position

Returns: the description of the dimension.

iterator nnvm::Layout::begin ( ) const

inline

Returns: begin iterator

bool nnvm::Layout::contains ( LayoutDim dim ) const

inline

Whether the layout contains a dimension.

Parameters

dim	dimension to be checked.

Returns: Whether the layout contains the dimension.

bool nnvm::Layout::convertible ( const Layout & dst ) const

inline

Two layouts are convertible only if they have same set of super-dimensions. e.g., NCHW, NCHW16c, NHWC are convertible between each other, but NCHW, CHW, OIHW are not.

Parameters

dst	the target layout

Returns: Whether can be converted to dst layout.

bool nnvm::Layout::defined ( ) const

inline

Returns: whether the layout is defined

iterator nnvm::Layout::end ( ) const

inline

Returns: end iterator

int32_t nnvm::Layout::indexof ( LayoutDim dim ) const

inline

return the index of the input dimension. If it is not found in the layout or the layout is undefined, return -1.

Parameters

dim	the input dimension.

Returns: the index or -1 if not found.

static bool nnvm::Layout::is_subdim ( LayoutDim dim )

inlinestatic

Check whether a given dimension is a sub-dimension.

Parameters

dim	input dimension

Returns: Whether a given dimension is a sub-dimension.

static bool nnvm::Layout::is_superdim ( LayoutDim dim )

inlinestatic

Check whether a given dimension is a super-dimension.

Parameters

dim	input dimension

Returns: Whether a given dimension is a super-dimension.

void nnvm::Layout::Load ( dmlc::JSONReader * reader )

inline

Load layout from JSON.

Parameters

reader JSONReader

const std::string& nnvm::Layout::name ( ) const

inline

Returns: the string description of the layout

size_t nnvm::Layout::ndim ( void ) const

inline

Returns: number of dimensions

bool nnvm::Layout::operator!= ( const Layout & s ) const

inline

Returns: whether two layout not equal

Parameters

s	the layout to compare against

Layout nnvm::Layout::operator+ ( const Layout & other ) const

inline

Append the current layout by another.

Parameters

other the layout to be appended

Returns: a new layout

Layout& nnvm::Layout::operator= ( const Layout & src )

inline

assignment from another layout.

Parameters

src	source layout

Returns: reference of self

Layout& nnvm::Layout::operator= ( Layout && src )

inline

assignment from rvalue of another layout.

Parameters

src	source layout

Returns: reference of self

Layout& nnvm::Layout::operator= ( const std::string & src )

inline

assignment from string.

Parameters

src	source layout

Returns: reference of self

bool nnvm::Layout::operator== ( const Layout & s ) const

inline

Returns: whether two layout equals

Parameters

s	the layout to compare against

LayoutDim nnvm::Layout::operator[] ( size_t i ) const

inline

reverse_iterator nnvm::Layout::rbegin ( ) const

inline

Returns: rbegin iterator

reverse_iterator nnvm::Layout::rend ( ) const

inline

Returns: rend iterator

Layout nnvm::Layout::reverse ( ) const

inline

Returns: A newly constructed reversed Layout object.

void nnvm::Layout::Save ( dmlc::JSONWriter * writer ) const

inline

Write layout in JSON format.

Parameters

writer JSONWriter

Layout nnvm::Layout::split	(	LayoutDim	dim,
		size_t	target_pos,
		uint32_t	size
	)		const

inline

Split dim by size and put the sub-dimension to position target_pos.

Parameters

dim	The source dimension to be split. It must be a super-dimension.
target_pos	The target position of the newly split sub-dimension.
size	size of the sub-dimension.

Returns: A newly constructed Layout object.

Layout nnvm::Layout::sublayout	(	size_t	pos,
		size_t	len
	)		const

inline

Returns a sublayout which is the portion of the object that starts at dimension pos and spans len dimensions (or until the end of the layout, whichever comes first).

Parameters

pos	The start position.
len	The length of the sub-layout.

Returns: A newly constructed Layout object.

int64_t nnvm::Layout::subsizeof ( LayoutDim dim ) const

inline

Parameters

dim	the input super-dimension or sub-dimension.

Returns: the size of the sub-dimension of dim (if dim is a super-dimension), or the size of dim itself (if dim is a sub-dimension). Return -1 if dim is not in the layout or the layout is undefined.

void nnvm::Layout::swap ( Layout & other )

inline

Swap current object with other.

Parameters

other another object to be swapped.

static LayoutDim nnvm::Layout::to_subdim ( LayoutDim dim )

inlinestatic

Convert a given dimension to sub-dimension.

Parameters

dim	input dimension

Returns: The converted description.

static LayoutDim nnvm::Layout::to_superdim ( LayoutDim dim )

inlinestatic

Convert a given dimension to super-dimension.

Parameters

dim	input dimension

Returns: The converted description.

static const Layout& nnvm::Layout::Undef ( )

inlinestatic

Return an undefined layout.

Returns: a (global) undefined layout.

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const Layout &	l
	)

friend

allow output string of layout to ostream

Parameters

os	the output stream
l	the layout

Returns: the ostream

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

/work/mxnet/3rdparty/tvm/nnvm/include/nnvm/layout.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation