cxsc::scmatrix_subv Class Reference

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

#include <scmatrix.hpp>

List of all members.

Public Member Functions
scmatrix_subv &	operator*= (const real &)
	Assign the componentwise product of the subvector with a scalar to the subvector.
scmatrix_subv &	operator*= (const complex &)
	Assign the componentwise product of the subvector with a scalar to the subvector.
scmatrix_subv &	operator+= (const srvector &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator+= (const srvector_slice &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator+= (const rvector &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator+= (const rvector_slice &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator+= (const scvector &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator+= (const scvector_slice &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator+= (const cvector &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator+= (const cvector_slice &)
	Assign the sum of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const srvector &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const srvector_slice &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const rvector &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const rvector_slice &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const scvector &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const scvector_slice &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const cvector &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator-= (const cvector_slice &)
	Assign the difference of the subvector with a vector to the subvector.
scmatrix_subv &	operator/= (const real &)
	Assign the componentwise division of the subvector with a scalar to the subvector.
scmatrix_subv &	operator/= (const complex &)
	Assign the componentwise division of the subvector with a scalar to the subvector.
scmatrix_subv &	operator= (const real &v)
	Assigns v to all elements of the subvector.
scmatrix_subv &	operator= (const complex &v)
	Assigns v to all elements of the subvector.
scmatrix_subv &	operator= (const srvector &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const scvector &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const srvector_slice &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const scvector_slice &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const rvector &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const cvector &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const rvector_slice &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const cvector_slice &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const srmatrix_subv &v)
	Assigns a vector to a subvector.
scmatrix_subv &	operator= (const scmatrix_subv &v)
	Assigns a vector to a subvector.
complex &	operator[] (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 &)
	Returns the imaginary part of the subvector.
int	Lb (const scmatrix_subv &)
	Returns the lower index bound of the subvector.
scvector	operator- (const scmatrix_subv &)
	Unary negation operator.
std::istream &	operator>> (std::istream &, scmatrix_subv &)
	Standard input operator for subvectors.
srvector	Re (const scmatrix_subv &)
	Returns the real part of the subvector.
int	Ub (const scmatrix_subv &)
	Returns the upper index bound of the subvector.
int	VecLen (const scmatrix_subv &)
	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

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.

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 files:

• scmatrix.hpp
• vector_friend_declarations.inl