LatNet Builder Manual  2.0.1-11
Software Package for Constructing Highly Uniform Point Sets
NTL::matrix< T > Class Template Reference

A subclass of the NTL::Mat<T> class. More...

#include <ntlwrap.h>

Inherits Mat< T >, and Mat< T >.

Public Types

typedef long size_type
 
typedef std::int64_t size_type
 

Public Member Functions

 matrix ()
 Constructor.
 
 matrix (const Mat< T > &a)
 
 matrix (size_type size1, size_type size2)
 
void resize (size_type size1, size_type size2)
 Set the matrix dimensions to (size1, size2) a copy from NTL::Mat<T>::SetDims.
 
void clear ()
 release space and set to length 0 a copy from NTL::Mat<T>::kill
 
size_type size1 () const
 return the number of rows
 
size_type size2 () const
 return the number of columns
 
T & operator() (size_type i, size_type j)
 change the indexation reference for ()() operator to start from 0 in NTL::Vec<T> the ()() operator starts from 1 wich is not compatible with boost
 
const T & operator() (size_type i, size_type j) const
 
 matrix ()
 Empty constructor.
 
 matrix (const Mat< T > &a)
 Copy constructor. More...
 
 matrix (size_type size1, size_type size2)
 Allocation constructor. More...
 
void resize (size_type size1, size_type size2)
 Set the matrix dimensions to size1 \(\times\)size2. More...
 
void clear ()
 Releases space and sets the matrix this size \(0\times 0\). More...
 
size_type size1 () const
 Returns the number of rows of the matrix.
 
size_type size2 () const
 Returns the number of columns of the matrix.
 
T & operator() (size_type i, size_type j)
 Overload to change the indexation reference for (i,j) operator to start from 0. More...
 
const T & operator() (size_type i, size_type j) const
 

Detailed Description

template<typename T>
class NTL::matrix< T >

A subclass of the NTL::Mat<T> class.

It extends its parent with a few methods and overloads a few others with more compatible defaults.

Member Typedef Documentation

◆ size_type

template<typename T>
typedef std::int64_t NTL::matrix< T >::size_type

Constructor & Destructor Documentation

◆ matrix() [1/2]

template<typename T>
NTL::matrix< T >::matrix ( const Mat< T > &  a)
inline

Copy constructor.

Creates a new matrix that is a copy of a.

Parameters
aMatrix to be copied.

◆ matrix() [2/2]

template<typename T>
NTL::matrix< T >::matrix ( size_type  size1,
size_type  size2 
)
inline

Allocation constructor.

Creates and allocates a size1 \(\times\)size2 matrix, initializing the elements T with their default constructor.

Parameters
size1Height of the matrix
size2Width of the matrix

Member Function Documentation

◆ clear()

template<typename T>
void NTL::matrix< T >::clear ( )
inline

Releases space and sets the matrix this size \(0\times 0\).

This uses NTL::Mat<T>::kill().

◆ operator()()

template<typename T>
T& NTL::matrix< T >::operator() ( size_type  i,
size_type  j 
)
inline

Overload to change the indexation reference for (i,j) operator to start from 0.

In NTL::Vec<T> the (i,j) operator starts from 1 which is not compatible with boost.

◆ resize()

template<typename T>
void NTL::matrix< T >::resize ( size_type  size1,
size_type  size2 
)
inline

Set the matrix dimensions to size1 \(\times\)size2.

This uses NTL::Mat<T>::SetDims(size1, size2).

Parameters
size1New height of the matrix.
size2New width of the matrix.

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