NTPoly
Loading...
Searching...
No Matches
Classes | Functions
NTPoly Namespace Reference

C++ interface to NTPoly. More...

Classes

class  Analysis
 A class for solving matrix equations. More...
 
class  ChebyshevPolynomial
 A Class For Computing Matrix functions based on Chebyshev polynomials. More...
 
class  ComplexOperation
 A function object defining an operation on a complex triplet list. More...
 
class  DensityMatrixSolvers
 A Class For Solving Chemistry Systems Based On Sparse Matrices. More...
 
class  EigenBounds
 A class for computing eigen bounds matrices. More...
 
class  EigenSolvers
 A class for computing eigen decompositions matrices. More...
 
class  ExponentialSolvers
 A Module For Computing General Matrix Exponentials. More...
 
class  FermiOperator
 A Class For Solving Chemistry Systems Using the Fermi Operator Expansion. More...
 
class  GeometryOptimization
 A Class For Solving Chemistry Systems Based On Sparse Matrices. More...
 
class  HermitePolynomial
 A Class For Computing Matrix functions based on Hermite polynomials. More...
 
class  InverseSolvers
 A class for inverting matrices. More...
 
class  LinearSolvers
 A class for solving matrix equations. More...
 
class  LoadBalancer
 A data structure for storing permutations. More...
 
class  Matrix_lsc
 A datatype for storing a CSR matrix (complex values). More...
 
class  Matrix_lsr
 A datatype for storing a CSR matrix (real values). More...
 
class  Matrix_ps
 A Module For Performing Distributed Sparse Matrix Operations. More...
 
class  MatrixConversion
 Helper routines for converting an NTPoly matrix to other program types. More...
 
class  MatrixMapper
 This class is used to apply an operation to each element in the matrix. More...
 
class  MatrixMemoryPool_c
 
class  MatrixMemoryPool_r
 
class  Permutation
 A data structure for storing permutations. More...
 
class  PMatrixMemoryPool
 
class  Polynomial
 A Class For Computing General Matrix Polynomials. More...
 
class  ProcessGrid
 A datatype which stores a process grid and all its communicators. More...
 
class  RealOperation
 A function object defining an operation on a real triplet list. More...
 
class  RootSolvers
 A Class For Computing General Matrix Roots. More...
 
class  SignSolvers
 A Class For Computing The Matrix Sign Function. More...
 
class  SolverBase
 A class that serves as the base class for all the solvers. More...
 
class  SolverParameters
 A class to store all the parameters used for solvers. More...
 
class  SquareRootSolvers
 A Class For Computing The Square Root of a Matrix. More...
 
class  TrigonometrySolvers
 A Module For Computing Trigonometric functions of a Matrix. More...
 
class  Triplet_c
 A Class For Storing Triplets of Integer, Integer, complex<Double>. More...
 
class  Triplet_r
 A Class For Storing Triplets of Integer, Integer, Double. More...
 
class  TripletList_c
 
class  TripletList_r
 

Functions

void ActivateLogger (bool start_document=false)
 
void ActivateLogger (const std::string file_name, bool start_document=false)
 
void DeactivateLogger ()
 Deactivate the logger.
 
void ConstructGlobalProcessGrid (MPI_Comm world_comm, int process_rows, int process_columns, int process_slices, bool be_verbose)
 
void ConstructGlobalProcessGrid (int process_rows, int process_columns, int process_slices, bool be_verbose)
 
void ConstructGlobalProcessGrid (MPI_Comm world_comm, int process_slices, bool be_verbose)
 
void ConstructGlobalProcessGrid (int process_slices, bool be_verbose)
 
void ConstructGlobalProcessGrid (bool be_verbose)
 
int GetGlobalMySlice ()
 Get the slice of the current process.
 
int GetGlobalMyColumn ()
 Get the column of the current process.
 
int GetGlobalMyRow ()
 Get the row of the current process.
 
bool GetGlobalIsRoot ()
 Get the current process is root.
 
int GetGlobalNumSlices ()
 Get the number of process slices.
 
int GetGlobalNumColumns ()
 Get the number of process columns.
 
void WriteGridInfo ()
 Write out some basic information about the global process grid to the log.
 
int GetGlobalNumRows ()
 Get the number of process rows.
 
void DestructGlobalProcessGrid ()
 Standard destructor.
 

Detailed Description

C++ interface to NTPoly.

A class to wrap up triplets of values.

Function Documentation

◆ ActivateLogger() [1/2]

void NTPoly::ActivateLogger ( bool  start_document = false)

Activate the logger.

Parameters
start_documentif this is a new document we can write the start document marker.

◆ ActivateLogger() [2/2]

void NTPoly::ActivateLogger ( const std::string  file_name,
bool  start_document = false 
)

Activate the logger with a specific file.

Parameters
file_namefile to print to.
start_documentif this is a new document we can write the start document marker.

◆ ConstructGlobalProcessGrid() [1/5]

void NTPoly::ConstructGlobalProcessGrid ( bool  be_verbose = false)

Construct the global process grid from comm world

Parameters
[in]be_verboseverbosity flag.

◆ ConstructGlobalProcessGrid() [2/5]

void NTPoly::ConstructGlobalProcessGrid ( int  process_rows,
int  process_columns,
int  process_slices,
bool  be_verbose = false 
)

Construct the global process grid from comm world

Parameters
[in]process_rowsnumber of grid rows.
[in]process_columnsnumber of grid columns.
[in]process_slicesnumber of grid slices.
[in]be_verboseverbosity flag.

◆ ConstructGlobalProcessGrid() [3/5]

void NTPoly::ConstructGlobalProcessGrid ( int  process_slices,
bool  be_verbose = false 
)

Construct the global process grid from comm world

Parameters
[in]process_slicesnumber of grid slices.
[in]be_verboseverbosity flag.

◆ ConstructGlobalProcessGrid() [4/5]

void NTPoly::ConstructGlobalProcessGrid ( MPI_Comm  world_comm,
int  process_rows,
int  process_columns,
int  process_slices,
bool  be_verbose = false 
)

Construct the global process grid.

Parameters
[in]world_comma communicator that every process in the grid is a part of.
[in]process_rowsnumber of grid rows.
[in]process_columnsnumber of grid columns.
[in]process_slicesnumber of grid slices.
[in]be_verboseverbosity flag.

◆ ConstructGlobalProcessGrid() [5/5]

void NTPoly::ConstructGlobalProcessGrid ( MPI_Comm  world_comm,
int  process_slices,
bool  be_verbose = false 
)

Construct the global process grid.

Parameters
[in]world_comma communicator that every process in the grid is a part of.
[in]process_slicesnumber of grid slices.
[in]be_verboseverbosity flag.