.TH "sc::SCDimension" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::SCDimension \- The \fBSCDimension\fP class is used to determine the size and blocking of matrices\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <dim\&.h>\fP
.PP
Inherits \fBsc::SavableState\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBSCDimension\fP (int \fBn\fP, const char *\fBname\fP=0)"
.br
.RI "Create a dimension with an optional name\&. "
.ti -1c
.RI "\fBSCDimension\fP (const \fBRef\fP< \fBSCBlockInfo\fP > &, const char *\fBname\fP=0)"
.br
.ti -1c
.RI "\fBSCDimension\fP (int \fBn\fP, int nblocks, const int *blocksizes=0, const char *\fBname\fP=0)"
.br
.ti -1c
.RI "\fBSCDimension\fP (const \fBRef\fP< \fBKeyVal\fP > &)"
.br
.RI "The \fBKeyVal\fP constructor\&. "
.ti -1c
.RI "\fBSCDimension\fP (\fBStateIn\fP &s)"
.br
.ti -1c
.RI "void \fBsave_data_state\fP (\fBStateOut\fP &)"
.br
.RI "Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. "
.ti -1c
.RI "int \fBequiv\fP (const \fBSCDimension\fP *) const"
.br
.RI "Test to see if two dimensions are equivalent\&. "
.ti -1c
.RI "int \fBn\fP () const"
.br
.RI "Return the dimension\&. "
.ti -1c
.RI "const char * \fBname\fP () const"
.br
.RI "Return the name of the dimension\&. "
.ti -1c
.RI "\fBRef\fP< \fBSCBlockInfo\fP > \fBblocks\fP ()"
.br
.RI "Return the blocking information for this dimension\&. "
.ti -1c
.RI "void \fBprint\fP (std::ostream &o=\fBExEnv::out0\fP()) const"
.br
.RI "Print information about this dimension to o\&. "
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBSCDimension\fP (const char *\fBname\fP=0)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "char * \fBname_\fP"
.br
.ti -1c
.RI "int \fBn_\fP"
.br
.ti -1c
.RI "\fBRef\fP< \fBSCBlockInfo\fP > \fBblocks_\fP"
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBSCDimension\fP class is used to determine the size and blocking of matrices\&. 

The blocking information is stored by an object of class \fBSCBlockInfo\fP\&. 
.br
 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::SCDimension::SCDimension (int n, const char * name = \fC0\fP)"

.PP
Create a dimension with an optional name\&. The name is a copy of the '0' terminated string name\&. 
.SS "sc::SCDimension::SCDimension (const \fBRef\fP< \fBKeyVal\fP > &)"

.PP
The \fBKeyVal\fP constructor\&. 
.IP "\fB\fCn\fP\fP" 1c
This gives size of the dimension\&. One of n or blocks is required\&.
.PP
.IP "\fB\fCblocks\fP\fP" 1c
The block information for the dimension can be given as a \fBSCBlockInfo\fP object\&. One of n or blocks is required\&.
.PP
.PP

.SH "Member Function Documentation"
.PP 
.SS "const char* sc::SCDimension::name () const\fC [inline]\fP"

.PP
Return the name of the dimension\&. If no name was given to the constructor, then return 0\&. 
.SS "void sc::SCDimension::save_data_state (\fBStateOut\fP &)\fC [virtual]\fP"

.PP
Save the base classes (with save_data_state) and the members in the same order that the \fBStateIn\fP CTOR initializes them\&. This must be implemented by the derived class if the class has data\&. 
.PP
Reimplemented from \fBsc::SavableState\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.