C-XSC - A C++ Class Library for Extended Scientific Computing 2.5.4
cxsc::scmatrix_subv Class Reference

Represents a row or column vector of a sparse matrix. More...

#include <scmatrix.hpp>

Collaboration diagram for cxsc::scmatrix_subv:
Collaboration graph

Public Member Functions

scmatrix_subvoperator*= (const complex &)
 Assign the componentwise product of the subvector with a scalar to the subvector.
 
scmatrix_subvoperator*= (const real &)
 Assign the componentwise product of the subvector with a scalar to the subvector.
 
scmatrix_subvoperator+= (const cvector &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator+= (const cvector_slice &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator+= (const rvector &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator+= (const rvector_slice &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator+= (const scvector &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator+= (const scvector_slice &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator+= (const srvector &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator+= (const srvector_slice &)
 Assign the sum of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const cvector &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const cvector_slice &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const rvector &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const rvector_slice &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const scvector &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const scvector_slice &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const srvector &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator-= (const srvector_slice &)
 Assign the difference of the subvector with a vector to the subvector

 
scmatrix_subvoperator/= (const complex &)
 Assign the componentwise division of the subvector with a scalar to the subvector

 
scmatrix_subvoperator/= (const real &)
 Assign the componentwise division of the subvector with a scalar to the subvector

 
scmatrix_subvoperator= (const complex &v)
 Assigns v to all elements of the subvector.
 
scmatrix_subvoperator= (const cvector &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const cvector_slice &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const real &v)
 Assigns v to all elements of the subvector.
 
scmatrix_subvoperator= (const rvector &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const rvector_slice &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const scmatrix_subv &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const scvector &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const scvector_slice &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const srmatrix_subv &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const srvector &v)
 Assigns a vector to a subvector.
 
scmatrix_subvoperator= (const srvector_slice &v)
 Assigns a vector to a subvector.
 
complexoperator[] (const int i)
 Returns a reference to the i-th element of the subvector.
 
const complex operator[] (const int i) const
 Returns a copy of the i-th element of the subvector.
 

Friends

srvector Im (const scmatrix_subv &S)
 Returns the imaginary part of the subvector.
 
int Lb (const scmatrix_subv &S)
 Returns the lower index bound of the subvector.
 
scvector operator- (const scmatrix_subv &v)
 Unary negation operator.
 
std::istream & operator>> (std::istream &is, scmatrix_subv &v)
 Standard input operator for subvectors.
 
srvector Re (const scmatrix_subv &S)
 Returns the real part of the subvector.
 
int Ub (const scmatrix_subv &S)
 Returns the upper index bound of the subvector.
 
int VecLen (const scmatrix_subv &S)
 Returns the length of the subvector.
 

Detailed Description

Represents a row or column vector of a sparse matrix.

This is a helper class created by the [] operator to represent a row or column of a sparse matrix. This helper class provides read and write access to the subvector using the standard operators. It is normally not necessary for the user to use this class explicitly, which is why the constructors are private.

Definition at line 3345 of file scmatrix.hpp.

Member Function Documentation

◆ operator[]() [1/2]

complex & cxsc::scmatrix_subv::operator[] ( const int i)
inline

Returns a reference to the i-th element of the subvector.

A refernce to the i-th element is returned. If this element is not explicitly stored, it is added as an explicit zero entry to the data structure.

Definition at line 3366 of file scmatrix.hpp.

◆ operator[]() [2/2]

const complex cxsc::scmatrix_subv::operator[] ( const int i) const
inline

Returns a copy of the i-th element of the subvector.

A copy to the i-th element is returned. If this element is not explicitly stored, 0 is returned

Definition at line 3386 of file scmatrix.hpp.


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