.TH "sc::RefSCVector" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::RefSCVector \- The \fBRefSCVector\fP class is a smart pointer to an \fBSCVector\fP specialization\&.  

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

.in +1c
.ti -1c
.RI "\fBRefSCVector\fP ()"
.br
.RI "Initializes the vector pointer to 0\&. "
.ti -1c
.RI "\fBRefSCVector\fP (const \fBRefSCVector\fP &v)"
.br
.RI "Make this and v refer to the same \fBSCVector\fP\&. "
.ti -1c
.RI "\fBRefSCVector\fP (\fBSCVector\fP *v)"
.br
.RI "Make this refer to v\&. "
.ti -1c
.RI "\fBRefSCVector\fP & \fBoperator=\fP (\fBSCVector\fP *v)"
.br
.RI "Make this refer to v\&. "
.ti -1c
.RI "\fBRefSCVector\fP & \fBoperator=\fP (const \fBRefSCVector\fP &v)"
.br
.RI "Make this and v refer to the same \fBSCVector\fP\&. "
.ti -1c
.RI "\fBRefSCVector\fP (const \fBRefSCDimension\fP &dim, const \fBRef\fP< \fBSCMatrixKit\fP > &)"
.br
.RI "Create a vector with dimension dim\&. "
.ti -1c
.RI "\fBSCVectordouble\fP \fBoperator()\fP (int) const"
.br
.RI "Return an l-value that can be used to assign or retrieve an element\&. "
.ti -1c
.RI "\fBSCVectordouble\fP \fBoperator[]\fP (int) const"
.br
.RI "Return an l-value that can be used to assign or retrieve an element\&. "
.ti -1c
.RI "\fBRefSCVector\fP \fBoperator+\fP (const \fBRefSCVector\fP &a) const"
.br
.RI "Add two vectors\&. "
.ti -1c
.RI "\fBRefSCVector\fP \fBoperator\-\fP (const \fBRefSCVector\fP &a) const"
.br
.RI "Subtract two vectors\&. "
.ti -1c
.RI "\fBRefSCVector\fP \fBoperator*\fP (double) const"
.br
.RI "Scale a vector\&. "
.ti -1c
.RI "\fBRefSCMatrix\fP \fBouter_product\fP (const \fBRefSCVector\fP &v) const"
.br
.RI "Return the outer product between this and v\&. "
.ti -1c
.RI "\fBRefSymmSCMatrix\fP \fBsymmetric_outer_product\fP () const"
.br
.RI "The outer product of this with itself is a symmetric matrix\&. "
.ti -1c
.RI "void \fBset_element\fP (int i, double val) const"
.br
.ti -1c
.RI "void \fBaccumulate_element\fP (int i, double val) const"
.br
.ti -1c
.RI "double \fBget_element\fP (int) const"
.br
.ti -1c
.RI "int \fBn\fP () const"
.br
.ti -1c
.RI "\fBRefSCDimension\fP \fBdim\fP () const"
.br
.ti -1c
.RI "\fBRef\fP< \fBSCMatrixKit\fP > \fBkit\fP () const"
.br
.ti -1c
.RI "\fBRefSCVector\fP \fBclone\fP () const"
.br
.ti -1c
.RI "\fBRefSCVector\fP \fBcopy\fP () const"
.br
.ti -1c
.RI "double \fBmaxabs\fP () const"
.br
.ti -1c
.RI "double \fBscalar_product\fP (const \fBRefSCVector\fP &) const"
.br
.ti -1c
.RI "double \fBdot\fP (const \fBRefSCVector\fP &) const"
.br
.ti -1c
.RI "void \fBnormalize\fP () const"
.br
.ti -1c
.RI "void \fBrandomize\fP () const"
.br
.ti -1c
.RI "void \fBassign\fP (const \fBRefSCVector\fP &v) const"
.br
.ti -1c
.RI "void \fBassign\fP (double val) const"
.br
.ti -1c
.RI "void \fBassign\fP (const double *v) const"
.br
.ti -1c
.RI "void \fBconvert\fP (double *) const"
.br
.ti -1c
.RI "void \fBscale\fP (double val) const"
.br
.ti -1c
.RI "void \fBaccumulate\fP (const \fBRefSCVector\fP &v) const"
.br
.ti -1c
.RI "void \fBaccumulate_product\fP (const \fBRefSymmSCMatrix\fP &, const \fBRefSCVector\fP &)"
.br
.ti -1c
.RI "void \fBaccumulate_product\fP (const \fBRefSCMatrix\fP &, const \fBRefSCVector\fP &)"
.br
.ti -1c
.RI "void \fBelement_op\fP (const \fBRef\fP< \fBSCElementOp\fP > &op) const"
.br
.ti -1c
.RI "void \fBelement_op\fP (const \fBRef\fP< \fBSCElementOp2\fP > &, const \fBRefSCVector\fP &) const"
.br
.ti -1c
.RI "void \fBelement_op\fP (const \fBRef\fP< \fBSCElementOp3\fP > &, const \fBRefSCVector\fP &, const \fBRefSCVector\fP &) const"
.br
.ti -1c
.RI "void \fBprint\fP (std::ostream &out) const"
.br
.ti -1c
.RI "void \fBprint\fP (const char *title=0, std::ostream &out=\fBExEnv::out0\fP(), int precision=10) const"
.br
.ti -1c
.RI "void \fBsave\fP (\fBStateOut\fP &)"
.br
.ti -1c
.RI "void \fBrestore\fP (\fBStateIn\fP &)"
.br
.RI "Restores the matrix from \fBStateIn\fP object\&. The vector must have been initialized already\&. "
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
The \fBRefSCVector\fP class is a smart pointer to an \fBSCVector\fP specialization\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "sc::RefSCVector::RefSCVector ()"

.PP
Initializes the vector pointer to 0\&. The reference must be initialized before it is used\&. 
.SS "sc::RefSCVector::RefSCVector (const \fBRefSCDimension\fP & dim, const \fBRef\fP< \fBSCMatrixKit\fP > &)"

.PP
Create a vector with dimension dim\&. The data values are undefined\&. 

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