mspass::utility::dvector Class Reference

A vector compatible with dmatrix objects. More...

#include <dmatrix.h>

Inheritance diagram for mspass::utility::dvector:

Public Member Functions
	dvector ()
	dvector (size_t nrv)
	dvector (const dvector &other)
dvector &	operator= (const dvector &other)
double &	operator() (size_t rowindex)
Public Member Functions inherited from mspass::utility::dmatrix
	dmatrix ()
	dmatrix (const size_t nr, const size_t nc)
	dmatrix (const dmatrix &other)
	~dmatrix ()
double	operator() (const size_t rowindex, const size_t colindex) const
double &	operator() (size_t r, size_t c)
dmatrix &	operator= (const dmatrix &other)
dmatrix &	operator+= (const dmatrix &other)
	Add one matrix to another.
dmatrix &	operator-= (const dmatrix &other)
	Subtract one matrix to another.
dmatrix	operator+ (const dmatrix &other) const
dmatrix	operator- (const dmatrix &other) const
dmatrix	operator* (double s) const noexcept
double *	get_address (size_t r, size_t c) const
size_t	rows () const
size_t	columns () const
std::vector< size_t >	size () const
	Return a vector with 2 elements giving the size.
void	zero ()

Friends
dvector	operator* (const dmatrix &A, const dvector &x)

Additional Inherited Members
Protected Attributes inherited from mspass::utility::dmatrix
std::vector< double >	ary
size_t	length
size_t	nrr
size_t	ncc

Detailed Description

A vector compatible with dmatrix objects.

A vector is a special case of a matrix with one row or column. In this implementation, however, it always means a column vector. Hence, it is possible to multiply a vector x and a matrix A as Ax provided they are compatible sizes. This differs from matlab where row and columns vectors are sometimes used interchangably.

Constructor & Destructor Documentation

dvector() [1/3]

mspass::utility::dvector::dvector ( )

inline

Default constructor creates an empty vector.

: dmatrix() {};

dvector() [2/3]

mspass::utility::dvector::dvector ( size_t  nrv )

inline

Create a (zero initialized) vector of length nrv.

: dmatrix(nrv, 1) {};

dvector() [3/3]

mspass::utility::dvector::dvector

(

const dvector &

other

)

Copy constructor.

                                     {
  ncc = 1;
  nrr = other.nrr;
  length = other.length;
  ary = other.ary;
}

Member Function Documentation

operator()()

double & mspass::utility::dvector::operator()

(

size_t

rowindex

)

Extract component rowindex.

                                                 {
  if (rowindex >= nrr)
    throw dmatrix_index_error(nrr, 1, rowindex, 1);
  return (ary[rowindex]);
}

operator=()

dvector & mspass::utility::dvector::operator=

(

const dvector &

other

)

Standard assignment operator.

                                                {
  if (this != &other) {
    ncc = 1;
    nrr = other.nrr;
    length = other.length;
    ary = other.ary;
  }
  return *this;
}

Friends And Related Symbol Documentation

operator*

dvector operator* ( const dmatrix &  A, const dvector &  x  )

friend

Matrix vector multiple operator.

This operator is used for constructs like y=Ax where x is a vector and A is a matrix. y is the returned vector.

Parameters

A	- matrix on right in multiply
x	- vector on left of multiply operation

Returns

product A*x

Exceptions

dmatrix_size_error

thrown if size of A and x do not match.

                                                       {
  size_t i;
  size_t nrx1 = x1.rows();
  size_t ncx1 = x1.columns();
  size_t nrb = const_cast<dvector &>(b).rows();
  if (ncx1 != nrb)
    throw dmatrix_size_error(nrx1, ncx1, nrb, 1);
  dvector prod(nrx1);
  for (i = 0; i < nrx1; i++)
    prod(i) = ddot(nrb, const_cast<dmatrix &>(x1).get_address(i, 0), nrx1,
                   const_cast<dvector &>(b).get_address(0, 0), 1);
  return prod;
}

---

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

• /home/runner/work/mspass/mspass/cxx/include/mspass/utility/dmatrix.h
• /home/runner/work/mspass/mspass/cxx/src/lib/utility/dmatrix.cc