cvcore::TensorBase Class Reference

Detailed Description

Implementation of TensorBase class.

Definition at line 120 of file Tensor.h.

Inheritance diagram for cvcore::TensorBase:

Data Structures
struct	DimData
	Struct for storing dimension data. More...

Public Member Functions
	TensorBase (ChannelType type, const DimData *dimData, int dimCount, void *dataPtr, bool isCPU)
	Constructor of a non-owning tensor. More...
	TensorBase (ChannelType type, std::initializer_list< DimData > dimData, void *dataPtr, bool isCPU)
	Constructor of a non-owning tensor. More...
	TensorBase (ChannelType type, const DimData *dimData, int dimCount, bool isCPU)
	Constructor of a memory-owning tensor. More...
	TensorBase (ChannelType type, std::initializer_list< DimData > dimData, bool isCPU)
	Constructor of a memory-owning tensor. More...
	~TensorBase ()
	Destructor of Tensor. More...
	TensorBase (const TensorBase &)=delete
	TensorBase is non-copyable. More...
TensorBase &	operator= (const TensorBase &)=delete
	TensorBase is non-copyable. More...
	TensorBase (TensorBase &&)
	Move Constructor of TensorBase. More...
TensorBase &	operator= (TensorBase &&)
	Move operator of TensorBase. More...
int	getDimCount () const
	Get the dimension count of TensorBase. More...
std::size_t	getSize (int dimIdx) const
	Get the size of given dimension. More...
std::size_t	getStride (int dimIdx) const
	Get the stride of given dimension. More...
ChannelType	getType () const
	Get the ChannelType of the Tensor. More...
void *	getData () const
	Get the raw data pointer to the Tensor. More...
std::size_t	getDataSize () const
	Get the total size of the Tensor in bytes. More...
bool	isCPU () const
	Get the flag whether the Tensor is allocated in CPU or GPU. More...
bool	isOwning () const
	Get the flag whether the Tensor owns the data. More...

Protected Member Functions
	TensorBase ()

Constructor & Destructor Documentation

TensorBase() [1/7]

cvcore::TensorBase::TensorBase	(	ChannelType	type,
		const DimData *	dimData,
		int	dimCount,
		void *	dataPtr,
		bool	isCPU
	)

Constructor of a non-owning tensor.

Parameters

type	ChannelType of the Tensor.
dimData	pointer to the DimData array.
dimCount	number of dimensions.
dataPtr	raw pointer to the source data array.
isCPU	whether to allocate tensor on CPU or GPU.

TensorBase() [2/7]

cvcore::TensorBase::TensorBase	(	ChannelType	type,
		std::initializer_list< DimData >	dimData,
		void *	dataPtr,
		bool	isCPU
	)

Constructor of a non-owning tensor.

Parameters

type	ChannelType of the Tensor.
dimData	initializer_list of DimData.
dataPtr	raw pointer to the source data array.
isCPU	whether to allocate tensor on CPU or GPU.

TensorBase() [3/7]

cvcore::TensorBase::TensorBase	(	ChannelType	type,
		const DimData *	dimData,
		int	dimCount,
		bool	isCPU
	)

Constructor of a memory-owning tensor.

Parameters

type	ChannelType of the Tensor.
dimData	pointer to the DimData array.
dimCount	number of dimensions.
isCPU	whether to allocate tensor on CPU or GPU.

TensorBase() [4/7]

cvcore::TensorBase::TensorBase	(	ChannelType	type,
		std::initializer_list< DimData >	dimData,
		bool	isCPU
	)

Constructor of a memory-owning tensor.

Parameters

type	ChannelType of the Tensor.
dimData	initializer_list of DimData.
isCPU	whether to allocate tensor on CPU or GPU.

~TensorBase()

cvcore::TensorBase::~TensorBase

(

)

Destructor of Tensor.

TensorBase() [5/7]

cvcore::TensorBase::TensorBase ( const TensorBase &  )

delete

TensorBase is non-copyable.

TensorBase() [6/7]

cvcore::TensorBase::TensorBase

(

TensorBase &&

)

Move Constructor of TensorBase.

TensorBase() [7/7]

cvcore::TensorBase::TensorBase ( )

protected

Member Function Documentation

getData()

void* cvcore::TensorBase::getData

(

)

const

Get the raw data pointer to the Tensor.

Returns

void data pointer to the Tensor.

Referenced by cvcore::detail::Tensor2D< CL, CT >::getData(), cvcore::detail::Tensor3D< CHW, CT >::getData(), and cvcore::detail::Tensor4D< DCHW, CT >::getData().

getDataSize()

std::size_t cvcore::TensorBase::getDataSize

(

)

const

Get the total size of the Tensor in bytes.

Returns

total bytes of the Tensor.

getDimCount()

int cvcore::TensorBase::getDimCount

(

)

const

Get the dimension count of TensorBase.

Returns

number of dimensions.

getSize()

std::size_t cvcore::TensorBase::getSize

(

int

dimIdx

)

const

Get the size of given dimension.

Parameters

dimIdx

dimension index.

Returns

size of the specified dimension.

Referenced by cvcore::detail::Tensor2D< CL, CT >::getChannelCount(), cvcore::detail::Tensor3D< CHW, CT >::getChannelCount(), cvcore::detail::Tensor4D< DCHW, CT >::getChannelCount(), cvcore::detail::Tensor4D< DCHW, CT >::getDepth(), cvcore::detail::Tensor3D< CHW, CT >::getHeight(), cvcore::detail::Tensor4D< DCHW, CT >::getHeight(), cvcore::detail::Tensor2D< CL, CT >::getLength(), cvcore::detail::Tensor3D< CHW, CT >::getWidth(), and cvcore::detail::Tensor4D< DCHW, CT >::getWidth().

getStride()

std::size_t cvcore::TensorBase::getStride

(

int

dimIdx

)

const

Get the stride of given dimension.

Parameters

dimIdx

dimension index.

Returns

stride of the specified dimension.

getType()

ChannelType cvcore::TensorBase::getType

(

)

const

Get the ChannelType of the Tensor.

Returns

ChannelType of the Tensor.

isCPU()

bool cvcore::TensorBase::isCPU

(

)

const

Get the flag whether the Tensor is allocated in CPU or GPU.

Returns

whether the Tensor is allocated in CPU.

isOwning()

bool cvcore::TensorBase::isOwning

(

)

const

Get the flag whether the Tensor owns the data.

Returns

whether the Tensor owns data in memory.

operator=() [1/2]

TensorBase& cvcore::TensorBase::operator= ( const TensorBase &  )

delete

TensorBase is non-copyable.

operator=() [2/2]

TensorBase& cvcore::TensorBase::operator=

(

TensorBase &&

)

Move operator of TensorBase.

---

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

• Tensor.h