ValArray is a class to efficiently store 3D array. More...

#include "val-array.h"

Inheritance diagram for ns3::ValArray< T >:

Collaboration diagram for ns3::ValArray< T >:

Public Member Functions
	ValArray ()=default

	ValArray (const std::valarray< T > &values)
	Constructor creates a single 1D array of values.size () elements and 1 column, and uses std::valarray<T> values to initialize the elements. More...

	ValArray (const std::vector< T > &values)
	Constructor creates a single 1D array of values.size () elements and 1 column, and uses values std::vector<T> to initialize the elements. More...

	ValArray (const ValArray< T > &)=default
	instruct the compiler to generate the implicitly declared copy constructor More...

	ValArray (std::valarray< T > &&values)
	Constructor creates a single 1D array of values.size () elements and 1 column, and moves std::valarray<T> values to initialize the elements. More...

	ValArray (uint16_t numRows, uint16_t numCols, const std::valarray< T > &values)
	Constructor creates a single 2D array of numRows and numCols, and uses std::valarray<T> values to initialize the elements. More...

	ValArray (uint16_t numRows, uint16_t numCols, std::valarray< T > &&values)
	Constructor creates a single 2D array of numRows and numCols, and moves std::valarray<T> values to initialize the elements. More...

	ValArray (uint16_t numRows, uint16_t numCols, uint16_t numPages, const std::valarray< T > &values)
	Constructor creates the 3D array of numRows x numCols x numPages dimensions, and uses std::valarray<T> values to initialize all the 2D arrays, where first numRows*numCols elements will belong to the first 2D array. More...

	ValArray (uint16_t numRows, uint16_t numCols, uint16_t numPages, std::valarray< T > &&values)
	Constructor creates the 3D array of numRows x numCols x numPages dimensions, and moves std::valarray<T> values to initialize all the 2D arrays, where first numRows*numCols elements will belong to the first 2D array. More...

	ValArray (uint16_t numRows, uint16_t numCols=1, uint16_t numPages=1)
	Constructor that creates "numPages" number of 2D arrays that are of dimensions "numRows"x"numCols", and are initialized with all-zero elements. More...

	ValArray (ValArray< T > &&)=default
	instruct the compiler to generate the implicitly declared move constructor More...

virtual	~ValArray ()=default
	instruct the compiler to generate the implicitly declared destructor More...

void	AssertEqualDims (const ValArray< T > &rhs) const
	Function that asserts if the dimensions of lhs and rhs ValArray are not equal and prints a message with the matrices dimensions. More...

T &	Elem (size_t row, size_t col, size_t page)
	Alternative access operator to access a specific element. More...

const T &	Elem (size_t row, size_t col, size_t page) const
	Alternative const access operator to access a specific element. More...

bool	EqualDims (const ValArray< T > &rhs) const
	Checks whether rhs and lhs ValArray objects have the same dimensions. More...

uint16_t	GetNumCols () const

uint16_t	GetNumPages () const

uint16_t	GetNumRows () const

T *	GetPagePtr (uint16_t pageIndex)
	Get a data pointer to a specific 2D array for use in linear algebra libraries. More...

const T *	GetPagePtr (uint16_t pageIndex) const
	Get a data pointer to a specific 2D array for use in linear algebra libraries. More...

size_t	GetSize () const

const std::valarray< T > &	GetValues () const
	Returns underlying values. More...

bool	IsAlmostEqual (const ValArray< T > &rhs, T tol) const
	Compare Valarray up to a given absolute tolerance. More...

bool	operator!= (const ValArray< T > &rhs) const
	operator!= definition for ValArray<T>. More...

T &	operator() (uint16_t index)
	Single-element access operator() for 1D ValArrays. More...

const T &	operator() (uint16_t index) const
	Single-element access operator() for 1D ValArrays. More...

T &	operator() (uint16_t rowIndex, uint16_t colIndex)
	Access operator for 2D ValArrays. More...

const T &	operator() (uint16_t rowIndex, uint16_t colIndex) const
	Const access operator for 2D ValArrays. More...

T &	operator() (uint16_t rowIndex, uint16_t colIndex, uint16_t pageIndex)
	Access operator, with bound-checking in debug profile. More...

const T &	operator() (uint16_t rowIndex, uint16_t colIndex, uint16_t pageIndex) const
	Const access operator, with bound-checking in debug profile. More...

ValArray< T >	operator* (const T &rhs) const
	Element-wise multiplication with a scalar value. More...

ValArray< T >	operator+ (const ValArray< T > &rhs) const
	operator+ definition for ValArray<T>. More...

ValArray< T > &	operator+= (const ValArray< T > &rhs)
	operator+= definition for ValArray<T>. More...

ValArray< T >	operator- () const
	unary operator- definition for ValArray<T>. More...

ValArray< T >	operator- (const ValArray< T > &rhs) const
	binary operator- definition for ValArray<T>. More...

ValArray< T > &	operator-= (const ValArray< T > &rhs)
	operator-= definition for ValArray<T>. More...

ValArray< T > &	operator= (const ValArray< T > &)=default
	Copy assignment operator. More...

ValArray< T > &	operator= (ValArray< T > &&)=default
	Move assignment operator. More...

bool	operator== (const ValArray< T > &rhs) const
	operator== definition for ValArray<T>. More...

T &	operator[] (size_t index)
	Single-element access operator[] that can be used to access a specific element of 1D ValArray. More...

const T &	operator[] (size_t index) const
	Const access operator that can be used to access a specific element of 1D ValArray. More...

Public Member Functions inherited from ns3::SimpleRefCount< ValArray< T > >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Protected Attributes
uint16_t	m_numCols
	The size of the second dimension, i.e., the number of columns of each 2D array. More...

uint16_t	m_numPages = 0
	The size of the third dimension, i.e., the number of 2D arrays. More...

uint16_t	m_numRows
	The size of the first dimension, i.e., the number of rows of each 2D array. More...

std::valarray< T >	m_values
	The data values. More...

Detailed Description

template<class T>
class ns3::ValArray< T >

ValArray is a class to efficiently store 3D array.

The class is general enough to represent 1D array or 2D arrays. ValArray also provides basic algebra element-wise operations over the whole array (1D, 2D, 3D).

Main characteristics of ValArray are the following:

ValArray uses std::valarray to efficiently store data.
In general, the elements are stored in memory as a sequence of consecutive 2D arrays. The dimensions of 2D arrays are defined by numRows and numCols, while the number of 2D arrays is defined by numPages. Notice that if we set the number of pages to 1, we will have only a single 2D array. If we additionally set numRows or numCols to 1, we will have 1D array.
All 2D arrays have the same dimensions, i.e. numRows and numCols.
2D arrays are stored in column-major order, which is the default order in Eigen and Armadillo libraries, which allows a straightforward mapping of any page (2D array) within ValArray to Eigen or Armadillo matrices.

Examples of column-major order:

a) in the case of a 2D array, we will have in memory the following order of elements, assuming that the indexes are rowIndex, colIndex, pageIndex:

a000 a100 a010 a110 a020 a120.

b) in the case of a 3D array, e.g, if there are two 2D arrays of 2x3 dimensions we will have in memory the following order of elements, assuming that the indexes are rowIndex, colIndex, pageIndex:

a000 a100 a010 a110 a020 a120 a001 a101 a011 a111 a021 a121.

The access to the elements is implemented in operators:
operator (rowIndex) and operator[] (rowIndex) for 1D array (assuming colIndex=0, pageIndex=0),
operator (rowIndex,colIndex) for 2D array (assuming pageIndex=0) and
operator(rowIndex, colIndex, pageIndex) for 3D array.

Definition of ValArray as a template class allows using different numerical types as the elements of the vectors/matrices, e.g., complex numbers, double, int, etc.

Definition at line 79 of file val-array.h.

Constructor & Destructor Documentation

◆ ValArray() [1/11]

template<class T >

ns3::ValArray< T >::ValArray ( )

default

References ns3::ValArray< T >::GetNumCols(), ns3::ValArray< T >::GetNumPages(), and ns3::ValArray< T >::GetNumRows().

Here is the call graph for this function:

◆ ValArray() [2/11]

template<class T >

ns3::ValArray< T >::ValArray	(	uint16_t	numRows,
		uint16_t	numCols = `1`,
		uint16_t	numPages = `1`
	)

Constructor that creates "numPages" number of 2D arrays that are of dimensions "numRows"x"numCols", and are initialized with all-zero elements.

If only 1 parameter, numRows, is provided then a single 1D array is being created.

Parameters

numRows	the number of rows
numCols	the number of columns
numPages	the number of pages

Definition at line 587 of file val-array.h.

References ns3::ValArray< T >::m_numCols, ns3::ValArray< T >::m_numPages, ns3::ValArray< T >::m_numRows, and ns3::ValArray< T >::m_values.

◆ ValArray() [3/11]

template<class T >

ns3::ValArray< T >::ValArray ( const std::valarray< T > & values )

explicit

Constructor creates a single 1D array of values.size () elements and 1 column, and uses std::valarray<T> values to initialize the elements.

Parameters

values std::valarray<T> that will be used to initialize elements of 1D array

Definition at line 596 of file val-array.h.

◆ ValArray() [4/11]

template<class T >

ns3::ValArray< T >::ValArray ( std::valarray< T > && values )

Constructor creates a single 1D array of values.size () elements and 1 column, and moves std::valarray<T> values to initialize the elements.

Parameters

values std::valarray<T> that will be moved to initialize elements of 1D array

Definition at line 605 of file val-array.h.

◆ ValArray() [5/11]

template<class T >

ns3::ValArray< T >::ValArray ( const std::vector< T > & values )

explicit

Constructor creates a single 1D array of values.size () elements and 1 column, and uses values std::vector<T> to initialize the elements.

Parameters

values std::vector<T> that will be used to initialize elements of 1D array

Definition at line 614 of file val-array.h.

References ns3::ValArray< T >::m_values.

◆ ValArray() [6/11]

template<class T >

ns3::ValArray< T >::ValArray	(	uint16_t	numRows,
		uint16_t	numCols,
		const std::valarray< T > &	values
	)

Constructor creates a single 2D array of numRows and numCols, and uses std::valarray<T> values to initialize the elements.

Parameters

numRows	the number of rows
numCols	the number of columns
values	valarray<T> that will be used to initialize elements of 3D array

Definition at line 624 of file val-array.h.

References ns3::ValArray< T >::m_numCols, ns3::ValArray< T >::m_numRows, and NS_ASSERT_MSG.

◆ ValArray() [7/11]

template<class T >

ns3::ValArray< T >::ValArray	(	uint16_t	numRows,
		uint16_t	numCols,
		std::valarray< T > &&	values
	)

Constructor creates a single 2D array of numRows and numCols, and moves std::valarray<T> values to initialize the elements.

Parameters

numRows	the number of rows
numCols	the number of columns
values	valarray<T> that will be used to initialize elements of 3D array

Definition at line 635 of file val-array.h.

References ns3::ValArray< T >::m_numCols, ns3::ValArray< T >::m_numRows, ns3::ValArray< T >::m_values, and NS_ASSERT_MSG.

◆ ValArray() [8/11]

template<class T >

ns3::ValArray< T >::ValArray	(	uint16_t	numRows,
		uint16_t	numCols,
		uint16_t	numPages,
		const std::valarray< T > &	values
	)

Constructor creates the 3D array of numRows x numCols x numPages dimensions, and uses std::valarray<T> values to initialize all the 2D arrays, where first numRows*numCols elements will belong to the first 2D array.

Parameters

numRows	the number of rows
numCols	the number of columns
numPages	the number of pages
values	valarray<T> that will be used to initialize elements of 3D array

Definition at line 646 of file val-array.h.

References ns3::ValArray< T >::m_numCols, ns3::ValArray< T >::m_numPages, ns3::ValArray< T >::m_numRows, and NS_ASSERT_MSG.

◆ ValArray() [9/11]

template<class T >

ns3::ValArray< T >::ValArray	(	uint16_t	numRows,
		uint16_t	numCols,
		uint16_t	numPages,
		std::valarray< T > &&	values
	)

Constructor creates the 3D array of numRows x numCols x numPages dimensions, and moves std::valarray<T> values to initialize all the 2D arrays, where first numRows*numCols elements will belong to the first 2D array.

Parameters

numRows	the number of rows
numCols	the number of columns
numPages	the number of pages
values	valarray<T> that will be used to initialize elements of 3D array

Definition at line 660 of file val-array.h.

References ns3::ValArray< T >::m_numCols, ns3::ValArray< T >::m_numPages, ns3::ValArray< T >::m_numRows, ns3::ValArray< T >::m_values, and NS_ASSERT_MSG.

◆ ~ValArray()

template<class T >

virtual ns3::ValArray< T >::~ValArray ( )

virtualdefault

instruct the compiler to generate the implicitly declared destructor

◆ ValArray() [10/11]

template<class T >

ns3::ValArray< T >::ValArray ( const ValArray< T > & )

default

instruct the compiler to generate the implicitly declared copy constructor

◆ ValArray() [11/11]

template<class T >

ns3::ValArray< T >::ValArray ( ValArray< T > && )

default

instruct the compiler to generate the implicitly declared move constructor

Member Function Documentation

◆ AssertEqualDims()

template<class T >

void ns3::ValArray< T >::AssertEqualDims ( const ValArray< T > & rhs ) const

Function that asserts if the dimensions of lhs and rhs ValArray are not equal and prints a message with the matrices dimensions.

Parameters

rhs	the rhs ValArray

Definition at line 703 of file val-array.h.

References ns3::ValArray< T >::m_numCols, ns3::ValArray< T >::m_numPages, ns3::ValArray< T >::m_numRows, and NS_ASSERT_MSG.

◆ Elem() [1/2]

template<class T >

T & ns3::ValArray< T >::Elem	(	size_t	row,
		size_t	col,
		size_t	page
	)

inline

Alternative access operator to access a specific element.

Parameters

row	the row index of the element to be obtained
col	the col index of the element to be obtained
page	the page index of the element to be obtained

Returns: a reference to the element of this ValArray

Definition at line 570 of file val-array.h.

References anonymous_namespace{print-introspected-doxygen.cc}::page.

◆ Elem() [2/2]

template<class T >

const T & ns3::ValArray< T >::Elem	(	size_t	row,
		size_t	col,
		size_t	page
	)		const

inline

Alternative const access operator to access a specific element.

Parameters

row	the row index of the element to be obtained
col	the column index of the element to be obtained
page	the page index of the element to be obtained

Returns: a const reference to the element of this ValArray

Definition at line 577 of file val-array.h.

References anonymous_namespace{print-introspected-doxygen.cc}::page.

◆ EqualDims()

template<class T >

bool ns3::ValArray< T >::EqualDims ( const ValArray< T > & rhs ) const

inline

Checks whether rhs and lhs ValArray objects have the same dimensions.

Parameters

rhs	The rhs ValArray

Returns: true if the dimensions of lhs and rhs are equal, otherwise it returns false

Definition at line 541 of file val-array.h.

References ns3::ValArray< T >::m_numCols, ns3::ValArray< T >::m_numPages, and ns3::ValArray< T >::m_numRows.

◆ GetNumCols()

template<class T >

uint16_t ns3::ValArray< T >::GetNumCols

inline

Returns: Number of columns

Definition at line 389 of file val-array.h.

Referenced by ns3::ValArray< T >::ValArray(), ns3::tests::MatrixArrayTestCase< T >::DoRun(), ns3::tests::ValArrayTestCase< T >::DoRun(), and ThreeGppChannelMatrixComputationTest::DoRun().

Here is the caller graph for this function:

◆ GetNumPages()

template<class T >

uint16_t ns3::ValArray< T >::GetNumPages

inline

Returns: Number of pages, i.e., the number of 2D arrays

Definition at line 396 of file val-array.h.

Referenced by ns3::ValArray< T >::ValArray(), ThreeGppChannelMatrixComputationTest::DoComputeNorm(), ns3::tests::MatrixArrayTestCase< T >::DoRun(), and ns3::tests::ValArrayTestCase< T >::DoRun().

Here is the caller graph for this function:

◆ GetNumRows()

template<class T >

uint16_t ns3::ValArray< T >::GetNumRows

inline

Returns: Number of rows

Definition at line 382 of file val-array.h.

Referenced by ns3::ValArray< T >::ValArray(), ns3::tests::MatrixArrayTestCase< T >::DoRun(), ns3::tests::ValArrayTestCase< T >::DoRun(), and ThreeGppChannelMatrixComputationTest::DoRun().

Here is the caller graph for this function:

◆ GetPagePtr() [1/2]

template<class T >

T * ns3::ValArray< T >::GetPagePtr ( uint16_t pageIndex )

inline

Get a data pointer to a specific 2D array for use in linear algebra libraries.

Parameters

pageIndex The index of the desired 2D array

Returns: a pointer to the data elements of the 2D array

Definition at line 525 of file val-array.h.

References NS_ASSERT_MSG.

Referenced by ns3::MatrixArray< T >::MultiplyByLeftAndRightMatrix(), and ns3::MatrixArray< T >::operator*().

Here is the caller graph for this function:

◆ GetPagePtr() [2/2]

template<class T >

const T * ns3::ValArray< T >::GetPagePtr ( uint16_t pageIndex ) const

inline

Get a data pointer to a specific 2D array for use in linear algebra libraries.

Parameters

pageIndex An index of the desired 2D array

Returns: a pointer to the data elements of the 2D array

Definition at line 533 of file val-array.h.

References NS_ASSERT_MSG.

◆ GetSize()

template<class T >

size_t ns3::ValArray< T >::GetSize

inline

Returns: Total number of elements

Definition at line 403 of file val-array.h.

Referenced by ns3::ThreeGppSpectrumPropagationLossModel::CalcBeamformingGain(), ns3::ThreeGppSpectrumPropagationLossModel::CalcLongTerm(), UniformPlanarArrayTestCase::ComputeGain(), ns3::tests::MatrixArrayTestCase< T >::DoRun(), ns3::tests::ValArrayTestCase< T >::DoRun(), ns3::PhasedArrayModel::norm(), ns3::operator<<(), and ns3::PhasedArrayModel::SetBeamformingVector().

Here is the caller graph for this function:

◆ GetValues()

template<class T >

const std::valarray< T > & ns3::ValArray< T >::GetValues

inline

Returns underlying values.

This function allows to directly work with the underlying values, which can be faster then using access operators.

Returns: A const reference to the underlying std::valarray<T>.

Definition at line 563 of file val-array.h.

Referenced by ns3::tests::MatrixArrayTestCase< T >::DoRun().

Here is the caller graph for this function:

◆ IsAlmostEqual()

template<class T >

bool ns3::ValArray< T >::IsAlmostEqual	(	const ValArray< T > &	rhs,
		T	tol
	)		const

Compare Valarray up to a given absolute tolerance.

This operation is element-wise operation, i.e., the elements with the same indices from the lhs and rhs ValArray are being compared, allowing the tolerance defined byt "tol" parameter.

Parameters

rhs	The rhs ValArray
tol	The absolute tolerance

Returns: true if the differences in each element-wise comparison is less or equal to tol.

Definition at line 690 of file val-array.h.

References ns3::ValArray< T >::m_values.

Referenced by ns3::tests::ValArrayTestCase< T >::DoRun().

Here is the caller graph for this function:

◆ operator!=()

template<class T >

bool ns3::ValArray< T >::operator!= ( const ValArray< T > & rhs ) const

operator!= definition for ValArray<T>.

Parameters

rhs	The ValArray instance to be compared with lhs ValArray instance

Returns: true if rhs ValArray is not equal to this ValArray, otherwise it returns true

Definition at line 683 of file val-array.h.

◆ operator()() [1/6]

template<class T >

T & ns3::ValArray< T >::operator() ( uint16_t index )

inline

Single-element access operator() for 1D ValArrays.

Assuming that the number of columns and pages is equal to 1, e.g. ValArray contains a single column or a single row.

Note: intentionally not implemented through three parameters access operator, to avoid accidental mistakes by user, e.g., providing 1 parameters when 2 or 3 are necessary.

Parameters

index The index of the 1D ValArray.

Returns: A reference to the value with the specified index.

Definition at line 448 of file val-array.h.

References NS_ASSERT_MSG.

◆ operator()() [2/6]

template<class T >

const T & ns3::ValArray< T >::operator() ( uint16_t index ) const

inline

Single-element access operator() for 1D ValArrays.

Parameters

index The index of the 1D ValArray.

Returns: The const reference to the values with the specified index.

Definition at line 461 of file val-array.h.

References NS_ASSERT_MSG.

◆ operator()() [3/6]

template<class T >

T & ns3::ValArray< T >::operator()	(	uint16_t	rowIndex,
		uint16_t	colIndex
	)

inline

Access operator for 2D ValArrays.

Assuming that the third dimension is equal to 1, e.g. ValArray contains a single 2D array. Note: intentionally not implemented through three parameters access operator, to avoid accidental mistakes by user, e.g., providing 2 parameters when 3 are necessary, but access operator would return valid value if default value of pages provided is 0.

Parameters

rowIndex	The index of the row
colIndex	The index of the column

Returns: A reference to the element with the specified indices

Definition at line 432 of file val-array.h.

References NS_ASSERT_MSG.

◆ operator()() [4/6]

template<class T >

const T & ns3::ValArray< T >::operator()	(	uint16_t	rowIndex,
		uint16_t	colIndex
	)		const

inline

Const access operator for 2D ValArrays.

Assuming that the third dimension is equal to 1, e.g. ValArray contains a single 2D array.

Parameters

rowIndex	row index
colIndex	column index

Returns: a Const reference to the value with the specified row and column index.

Definition at line 440 of file val-array.h.

References NS_ASSERT_MSG.

◆ operator()() [5/6]

template<class T >

T & ns3::ValArray< T >::operator()	(	uint16_t	rowIndex,
		uint16_t	colIndex,
		uint16_t	pageIndex
	)

inline

Access operator, with bound-checking in debug profile.

Parameters

rowIndex	The index of the row
colIndex	The index of the column
pageIndex	The index of the page

Returns: A const reference to the element with with rowIndex, colIndex and pageIndex indices.

Definition at line 410 of file val-array.h.

References NS_ASSERT_MSG.

◆ operator()() [6/6]

template<class T >

const T & ns3::ValArray< T >::operator()	(	uint16_t	rowIndex,
		uint16_t	colIndex,
		uint16_t	pageIndex
	)		const

inline

Const access operator, with bound-checking in debug profile.

Parameters

rowIndex	The index of the row
colIndex	The index of the column
pageIndex	The index of the page

Returns: A const reference to the element with with rowIndex, colIndex and pageIndex indices.

Definition at line 421 of file val-array.h.

References NS_ASSERT_MSG.

◆ operator*()

template<class T >

ValArray< T > ns3::ValArray< T >::operator* ( const T & rhs ) const

inline

Element-wise multiplication with a scalar value.

Parameters

rhs	A scalar value of type T

Returns: ValArray in which each element has been multiplied by the given scalar value.

Definition at line 474 of file val-array.h.

◆ operator+()

template<class T >

ValArray< T > ns3::ValArray< T >::operator+ ( const ValArray< T > & rhs ) const

inline

operator+ definition for ValArray<T>.

Parameters

rhs	The rhs ValArray to be added to this ValArray.

Returns: the ValArray instance that holds the results of the operator+

Definition at line 484 of file val-array.h.

References ns3::ValArray< T >::m_values.

◆ operator+=()

template<class T >

ValArray< T > & ns3::ValArray< T >::operator+= ( const ValArray< T > & rhs )

inline

operator+= definition for ValArray<T>.

Parameters

rhs	The rhs ValArray to be added to this ValArray.

Returns: a reference to this ValArray instance

Definition at line 507 of file val-array.h.

References ns3::ValArray< T >::m_values.

◆ operator-() [1/2]

template<class T >

ValArray< T > ns3::ValArray< T >::operator-

inline

unary operator- definition for ValArray<T>.

Returns: the ValArray instance that holds the results of the operator-

Definition at line 500 of file val-array.h.

◆ operator-() [2/2]

template<class T >

ValArray< T > ns3::ValArray< T >::operator- ( const ValArray< T > & rhs ) const

inline

binary operator- definition for ValArray<T>.

Parameters

rhs	The rhs ValArray to be subtracted from this ValArray.

Returns: the ValArray instance that holds the results of the operator-

Definition at line 492 of file val-array.h.

References ns3::ValArray< T >::m_values.

◆ operator-=()

template<class T >

ValArray< T > & ns3::ValArray< T >::operator-= ( const ValArray< T > & rhs )

inline

operator-= definition for ValArray<T>.

Parameters

rhs	The rhs ValArray to be subtracted from this ValArray.

Returns: a reference to this ValArray instance

Definition at line 516 of file val-array.h.

References ns3::ValArray< T >::m_values.

◆ operator=() [1/2]

template<class T >

ValArray<T>& ns3::ValArray< T >::operator= ( const ValArray< T > & )

default

Copy assignment operator.

Instruct the compiler to generate the implicitly declared copy assignment operator.

Returns: a reference to the assigned object

◆ operator=() [2/2]

template<class T >

ValArray<T>& ns3::ValArray< T >::operator= ( ValArray< T > && )

default

Move assignment operator.

Instruct the compiler to generate the implicitly declared move assignment operator.

Returns: a reference to the assigned object

◆ operator==()

template<class T >

bool ns3::ValArray< T >::operator== ( const ValArray< T > & rhs ) const

operator== definition for ValArray<T>.

Parameters

rhs	The ValArray instance to be compared with lhs ValArray instance

Returns: true if rhs ValArray is equal to this ValArray, otherwise it returns false

Definition at line 675 of file val-array.h.

References ns3::ValArray< T >::m_values.

◆ operator[]() [1/2]

template<class T >

T & ns3::ValArray< T >::operator[] ( size_t index )

inline

Single-element access operator[] that can be used to access a specific element of 1D ValArray.

It mimics operator[] from std::vector. This function is introduced for compatibility with ns-3 usage of 1D arrays, which are usually represented through std::vector operators in spectrum and antenna module.

Parameters

index The index of the element to be returned

Returns: A reference to a specific element from the underlying std::valarray.

Definition at line 549 of file val-array.h.

◆ operator[]() [2/2]

template<class T >

const T & ns3::ValArray< T >::operator[] ( size_t index ) const

inline

Const access operator that can be used to access a specific element of 1D ValArray.

Parameters

index The index of the element to be returned

Returns: A const reference to a specific element from the underlying std::valarray.

Definition at line 556 of file val-array.h.

Member Data Documentation

◆ m_numCols

template<class T >

uint16_t ns3::ValArray< T >::m_numCols

protected

Initial value:

=

0

The size of the second dimension, i.e., the number of columns of each 2D array.

Definition at line 370 of file val-array.h.

Referenced by ns3::ValArray< T >::ValArray(), ns3::ValArray< T >::AssertEqualDims(), ns3::ValArray< T >::EqualDims(), ns3::MatrixArray< T >::MultiplyByLeftAndRightMatrix(), and ns3::MatrixArray< T >::operator*().

◆ m_numPages

template<class T >

uint16_t ns3::ValArray< T >::m_numPages = 0

protected

The size of the third dimension, i.e., the number of 2D arrays.

Definition at line 372 of file val-array.h.

Referenced by ns3::ValArray< T >::ValArray(), ns3::ValArray< T >::AssertEqualDims(), ns3::ValArray< T >::EqualDims(), ns3::MatrixArray< T >::MultiplyByLeftAndRightMatrix(), and ns3::MatrixArray< T >::operator*().

◆ m_numRows

template<class T >

uint16_t ns3::ValArray< T >::m_numRows

protected

Initial value:

=

0

The size of the first dimension, i.e., the number of rows of each 2D array.

Definition at line 368 of file val-array.h.

Referenced by ns3::ValArray< T >::ValArray(), ns3::ValArray< T >::AssertEqualDims(), ns3::ValArray< T >::EqualDims(), ns3::MatrixArray< T >::MultiplyByLeftAndRightMatrix(), and ns3::MatrixArray< T >::operator*().

◆ m_values

template<class T >

std::valarray<T> ns3::ValArray< T >::m_values

protected

The data values.

Definition at line 373 of file val-array.h.

Referenced by ns3::ValArray< T >::ValArray(), ns3::ValArray< T >::IsAlmostEqual(), ns3::MatrixArray< T >::MultiplyByLeftAndRightMatrix(), ns3::MatrixArray< T >::operator*(), ns3::MatrixArray< T >::operator+(), ns3::ValArray< T >::operator+(), ns3::ValArray< T >::operator+=(), ns3::MatrixArray< T >::operator-(), ns3::ValArray< T >::operator-(), ns3::ValArray< T >::operator-=(), and ns3::ValArray< T >::operator==().

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

src/core/model/val-array.h

Public Member Functions

Protected Attributes

Detailed Description

template<class T> class ns3::ValArray< T >

Constructor & Destructor Documentation

◆ ValArray() [1/11]

◆ ValArray() [2/11]

◆ ValArray() [3/11]

◆ ValArray() [4/11]

◆ ValArray() [5/11]

◆ ValArray() [6/11]

◆ ValArray() [7/11]

◆ ValArray() [8/11]

◆ ValArray() [9/11]

◆ ~ValArray()

◆ ValArray() [10/11]

◆ ValArray() [11/11]

Member Function Documentation

◆ AssertEqualDims()

◆ Elem() [1/2]

◆ Elem() [2/2]

◆ EqualDims()

◆ GetNumCols()

◆ GetNumPages()

◆ GetNumRows()

◆ GetPagePtr() [1/2]

◆ GetPagePtr() [2/2]

◆ GetSize()

◆ GetValues()

◆ IsAlmostEqual()

◆ operator!=()

◆ operator()() [1/6]

◆ operator()() [2/6]

◆ operator()() [3/6]

◆ operator()() [4/6]

◆ operator()() [5/6]

◆ operator()() [6/6]

◆ operator*()

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

Member Data Documentation

◆ m_numCols

◆ m_numPages

◆ m_numRows

◆ m_values

template<class T>
class ns3::ValArray< T >