General complex matrix. More...

#include <matrix.h>

Inheritance diagram for matrix:

Public Member Functions
int	nRows () const

int	nCols () const

int	index (int i, int j) const
	Index into data()

	operator bool () const
	Test null-ness of matrix.

void	init (int nrows, int ncols, bool onGpu=false)
	called by the constructors

void	reshape (int nrows, int ncols)
	change the dimensions without altering the data (zero dimensions are filled in to match size)

	matrix (int nrows=0, int ncols=0, bool onGpu=false)

	matrix (const matrix &m1)
	copy constructor

	matrix (matrix &&m1)
	move constructor

	matrix (const diagMatrix &)
	convert from a real diagonal matrix

	matrix (const std::vector< complex > &)
	convert from a complex diagonal matrix

	matrix (const matrix3<> &)
	convert from a 3x3 matrix

matrix &	operator= (const matrix &m1)
	copy-assignment

matrix &	operator= (matrix &&m1)
	move-assignment

complex	operator() (int i, int j) const
	get a specific element of the matrix

matrix	operator() (int iStart, int iStop, int jStart, int jStop) const
	get submatrix of elements (iStart <= i < iStop, jStart <= j < jStop)

matrix	operator() (int iStart, int iStep, int iStop, int jStart, int jStep, int jStop) const
	get submatrix of elements (iStart <= i < iStop, jStart <= j < jStop) with arbitrary increments

void	set (int i, int j, complex m)
	set element to m

void	set (int iStart, int iStop, int jStart, int jStop, const matrix &m)
	set submatrix to m

void	set (int iStart, int iStep, int iStop, int jStart, int jStep, int jStop, const matrix &m)
	set submatrix to m at arbitrary increments

void	scan (FILE fp, const char fmt="%lg%+lgi")
	read (ascii) from stream

void	scan_real (FILE *fp)
	read (ascii) real parts from stream, setting imaginary parts to 0

void	print (FILE fp, const char fmt="%lg%+lgi\t") const
	print (ascii) to stream

void	print_real (FILE fp, const char fmt="%lg\t") const
	print (ascii) real parts to stream

void	diagonalize (matrix &evecs, diagMatrix &eigs) const
	diagonalize a hermitian matrix

void	diagonalize (matrix &levecs, std::vector< complex > &eigs, matrix &revecs) const
	diagonalize an arbitrary matrix

void	svd (matrix &U, diagMatrix &S, matrix &Vdag) const
	singular value decomposition (for dimensions of this: MxN, on output U: MxM, S: min(M,N), Vdag: NxN)

complex	getElement (vector3< int > index, class GridInfo &gInfo)
	get element at grid coordinate from a NxNyNzx1 matrix

matrix	getLine (vector3< int > line, vector3< int > point, class GridInfo &gInfo)
	get a linear slice from a NxNyNzx1 matrix

matrix	getPlane (vector3< int > normal, vector3< int > point, class GridInfo &gInfo)
	get a planar slice from a NxNyNzx1 matrix

Public Member Functions inherited from ManagedMemory< complex >
complex *	data ()
	Return a pointer to the actual data Return a CPU pointer to the actual data, will move data from GPU to CPU if necessary In GPU mode, care must be taken when calling this from multiple cpu threads Only the "GPU Owner" thread may call this when the data is actually on the GPU. Ideally call once from main thread to get data onto the cpu before launching other cpu threads.

const complex *	data () const
	Return a const pointer to the actual data Return a CPU pointer to the actual data, will move data from GPU to CPU if necessary In GPU mode, care must be taken when calling this from multiple cpu threads Only the "GPU Owner" thread may call this when the data is actually on the GPU. Ideally call once from main thread to get data onto the cpu before launching other cpu threads.

complex *	dataGpu ()
	Get a GPU data pointer (must be called from GPU owner thread)

const complex *	dataGpu () const
	Get a const GPU data pointer (must be called from GPU owner thread)

size_t	nData () const
	number of data points

bool	isOnGpu () const
	Check where the data is (for #ifdef simplicity exposed even when no GPU_ENABLED)

complex *	begin ()
	pointer to start of array

const complex *	begin () const
	const pointer to start of array

const complex *	cbegin () const
	const pointer to start of array

complex *	end ()
	pointer just past end of array

const complex *	end () const
	const pointer just past end of array

const complex *	cend () const
	const pointer just past end of array

complex *	dataPref ()

const complex *	dataPref () const

void	send (int dest, int tag=0) const
	send to another process

void	recv (int src, int tag=0)
	receive from another process

void	bcast (int root=0)
	synchronize across processes (using value on specified root process)

void	allReduce (MPIUtil::ReduceOp op, bool safeMode=false)
	apply all-to-all reduction (see MPIUtil::allReduce)

void	read (const char *fname)
	binary read from a file

void	read (FILE *filep)
	binary read from a stream

void	write (const char *fname) const
	binary-write to a file

void	write (FILE *filep) const
	binary-write toa stream

void	read_real (const char *fname)
	binary read real-part from file, setting imaginary parts to 0

void	read_real (FILE *filep)
	binary read real-part from stream, setting imaginary parts to 0

void	write_real (const char *fname) const
	binary write real-parts to file

void	write_real (FILE *filep) const
	binary write real-parts to stream

void	dump (const char *fname, bool realPartOnly) const
	write as complex or real-part alone and report discarded imaginary part, if any

void	zero ()
	set all elements to zero

Additional Inherited Members
Protected Member Functions inherited from ManagedMemory< complex >
	ManagedMemory ()
	Initialize a valid state, but don't allocate anything.

void	memFree ()
	Free memory.

void	memInit (string category, size_t nElem, bool onGpu=false)
	Allocate memory.

void	memMove (ManagedMemory< complex > &&)
	Steal the other object's data (used for move constructors/assignment)

Detailed Description

General complex matrix.

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

core/matrix.h

Public Member Functions

Additional Inherited Members

Detailed Description