cgal/Parameterization/doc_tex/Parameterization_ref/Vector.tex

120 lines
2.4 KiB
TeX

% +------------------------------------------------------------------------+
% | Reference manual page: Vector.tex
% +------------------------------------------------------------------------+
% | 21.09.2005 Laurent Saboret, Pierre Alliez
% | Package: Parameterization
% |
\RCSdef{\RCSVectorRev}{$Revision$}
\RCSdefDate{\RCSVectorDate}{$Date$}
% |
%%RefPage: end of header, begin of main body
% +------------------------------------------------------------------------+
\begin{ccRefConcept}[SparseLinearAlgebra_d::]{Vector}
%% \ccHtmlCrossLink{} %% add further rules for cross referencing links
%% \ccHtmlIndexC[concept]{} %% add further index entries
\ccDefinition
% The section below is automatically generated. Do not edit!
%START-AUTO(\ccDefinition)
SparseLinearAlgebraTraits\_d::Vector is a concept of a vector that can be multiplied by a sparse matrix.
%END-AUTO(\ccDefinition)
\ccRefines
% The section below is automatically generated. Do not edit!
%START-AUTO(\ccRefines)
This is a sub-concept of LinearAlgebraTraits\_d::Vector.
%END-AUTO(\ccRefines)
\ccTypes
% The section below is automatically generated. Do not edit!
%START-AUTO(\ccTypes)
\ccNestedType{NT}
{
}
\ccGlue
%END-AUTO(\ccTypes)
\ccCreation
\ccCreationVariable{v} %% variable name for \ccMethod
% The section below is automatically generated. Do not edit!
%START-AUTO(\ccCreation)
\ccConstructor{Vector (int rows);}
{
Create a vector initialized with zeros.
}
\ccGlue
\ccConstructor{Vector (const Vector & toCopy);}
{
Copy constructor.
}
\ccGlue
%END-AUTO(\ccCreation)
\ccOperations
% The section below is automatically generated. Do not edit!
%START-AUTO(\ccOperations)
\ccMethod{Vector& operator= (const Vector & toCopy);}
{
operator =()
}
\ccGlue
\ccMethod{int dimension () const;}
{
Return the vector's number of coefficients.
}
\ccGlue
\ccMethod{NT operator[] (int row) const;}
{
Read/write access to 1 vector coefficient.
Precondition: 0 $<$= row $<$ dimension().
}
\ccGlue
\ccMethod{NT& operator[] (int row);}
{
}
\ccGlue
%END-AUTO(\ccOperations)
\ccHasModels
\ccRefIdfierPage{CGAL::Taucs_vector} \\
\ccc{OpenNL::FullVector} \\
\ccSeeAlso
\ccRefIdfierPage{SparseLinearAlgebraTraits_d} \\
\ccRefIdfierPage{SparseLinearAlgebraTraits_d::Matrix} \\
\end{ccRefConcept}
% +------------------------------------------------------------------------+
%%RefPage: end of main body, begin of footer
% EOF
% +------------------------------------------------------------------------+