GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
ColumnVector Class Reference

#include "dColVector.h"

Inheritance diagram for ColumnVector:
MArray< double > Array< double >

Public Member Functions

 ColumnVector ()
 
 ColumnVector (const Array< double > &a)
 
 ColumnVector (const ColumnVector &a)
 
 ColumnVector (const dim_vector &dv)
 
 ColumnVector (const MArray< double > &a)
 
 ColumnVector (octave_idx_type n)
 
 ColumnVector (octave_idx_type n, double val)
 
 ~ColumnVector ()=default
 
ColumnVector abs () const
 
void clear (octave_idx_type n)
 
ColumnVector extract (octave_idx_type r1, octave_idx_type r2) const
 
ColumnVector extract_n (octave_idx_type r1, octave_idx_type n) const
 
ColumnVectorfill (double val)
 
ColumnVectorfill (double val, octave_idx_type r1, octave_idx_type r2)
 
ColumnVectorinsert (const ColumnVector &a, octave_idx_type r)
 
double max () const
 
double min () const
 
bool operator!= (const ColumnVector &a) const
 
ColumnVectoroperator= (const ColumnVector &a)
 
bool operator== (const ColumnVector &a) const
 
void resize (octave_idx_type n, const double &rfv=0)
 
ColumnVector stack (const ColumnVector &a) const
 
RowVector transpose () const
 
- Public Member Functions inherited from MArray< double >
 MArray ()
 
 MArray (const Array< U > &a)
 
 MArray (const dim_vector &dv)
 
 MArray (const dim_vector &dv, const double &val)
 
 MArray (const MArray< double > &a)
 
 ~MArray ()=default
 
void changesign ()
 
MArray< double > hermitian (double(*fcn)(const double &)=nullptr) const
 
void idx_add (const octave::idx_vector &idx, const MArray< double > &vals)
 
void idx_add (const octave::idx_vector &idx, double val)
 Performs indexed accumulative addition. More...
 
void idx_add_nd (const octave::idx_vector &idx, const MArray< double > &vals, int dim=-1)
 
void idx_max (const octave::idx_vector &idx, const MArray< double > &vals)
 
void idx_min (const octave::idx_vector &idx, const MArray< double > &vals)
 
MArray< double > ipermute (const Array< octave_idx_type > &vec) const
 
MArray< double > & operator= (const MArray< double > &a)
 
MArray< double > permute (const Array< octave_idx_type > &vec, bool inv=false) const
 
MArray< double > reshape (const dim_vector &new_dims) const
 
MArray squeeze () const
 
MArray< double > transpose () const
 
- Public Member Functions inherited from Array< double >
 Array ()
 Empty ctor (0 by 0). More...
 
 Array (Array< double, Alloc > &&a)
 
 Array (const Array< double, Alloc > &a)
 No type conversion case. More...
 
 Array (const Array< double, Alloc > &a, const dim_vector &dv)
 Reshape constructor. More...
 
 Array (const Array< U, A > &a)
 Type conversion case. More...
 
 Array (const Container< double > &a, const dim_vector &dv)
 Constructor from standard library sequence containers. More...
 
 Array (const dim_vector &dv)
 nD uninitialized ctor. More...
 
 Array (const dim_vector &dv, const double &val)
 nD initialized ctor. More...
 
 Array (double *ptr, const dim_vector &dv, const Alloc &xallocator=Alloc())
 
virtual ~Array ()
 
Array< double, Allocas_column () const
 Return the array as a column vector. More...
 
Array< double, Allocas_matrix () const
 Return the array as a matrix. More...
 
Array< double, Allocas_row () const
 Return the array as a row vector. More...
 
void clear ()
 
void clear (const dim_vector &dv)
 
void clear (octave_idx_type r, octave_idx_type c)
 
void fill (const double &val)
 
Array< octave_idx_typefind (octave_idx_type, bool) const
 
Array< octave_idx_typefind (octave_idx_type, bool) const
 
sortmode is_sorted_rows (sortmode) const
 
sortmode is_sorted_rows (sortmode) const
 
sortmode issorted (sortmode mode) const
 
sortmode issorted (sortmode) const
 
sortmode issorted (sortmode) const
 
Array< octave_idx_typelookup (const Array< octave::cdef_object > &, sortmode) const
 
Array< octave_idx_typelookup (const Array< octave::idx_vector > &, sortmode) const
 
octave_idx_type lookup (octave::cdef_object const &, sortmode) const
 
octave_idx_type lookup (octave::idx_vector const &, sortmode) const
 
void make_unique ()
 
octave_idx_type nnz () const
 
octave_idx_type nnz () const
 
Array< octave::cdef_object > nth_element (const octave::idx_vector &, int) const
 
Array< octave::idx_vectornth_element (const octave::idx_vector &, int) const
 
octave_idx_type numel () const
 Number of elements in the array. More...
 
Array< double, Alloc > & operator= (Array< double, Alloc > &&a)
 
Array< double, Alloc > & operator= (const Array< double, Alloc > &a)
 
Array< octave::cdef_object > sort (Array< octave_idx_type > &sidx, int, sortmode) const
 
Array< octave::idx_vectorsort (Array< octave_idx_type > &sidx, int, sortmode) const
 
Array< octave::cdef_object > sort (int, sortmode) const
 
Array< octave::idx_vectorsort (int, sortmode) const
 
Array< octave_idx_typesort_rows_idx (sortmode) const
 
Array< octave_idx_typesort_rows_idx (sortmode) const
 
octave_idx_type dim1 () const
 
octave_idx_type rows () const
 
octave_idx_type dim2 () const
 
octave_idx_type cols () const
 
octave_idx_type columns () const
 
octave_idx_type dim3 () const
 Size of the specified dimension. More...
 
octave_idx_type pages () const
 Size of the specified dimension. More...
 
size_type size (const size_type d) const
 Size of the specified dimension. More...
 
std::size_t byte_size () const
 Size of the specified dimension. More...
 
const dim_vectordims () const
 Return a const-reference so that dims ()(i) works efficiently. More...
 
Array< double, Allocsqueeze () const
 Chop off leading singleton dimensions. More...
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
octave_idx_type compute_index (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
octave_idx_type compute_index (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
octave_idx_type compute_index_unchecked (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
double & xelem (octave_idx_type n)
 Size of the specified dimension. More...
 
crefT xelem (octave_idx_type n) const
 Size of the specified dimension. More...
 
double & xelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
crefT xelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
double & xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
crefT xelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
double & xelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT xelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
double & checkelem (octave_idx_type n)
 Size of the specified dimension. More...
 
double & checkelem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
double & checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
double & checkelem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT checkelem (octave_idx_type n) const
 Size of the specified dimension. More...
 
crefT checkelem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
crefT checkelem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
crefT checkelem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
double & elem (octave_idx_type n)
 Size of the specified dimension. More...
 
double & elem (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
double & elem (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
double & elem (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT elem (octave_idx_type n) const
 Size of the specified dimension. More...
 
crefT elem (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
crefT elem (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
crefT elem (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
double & operator() (octave_idx_type n)
 Size of the specified dimension. More...
 
double & operator() (octave_idx_type i, octave_idx_type j)
 Size of the specified dimension. More...
 
double & operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k)
 Size of the specified dimension. More...
 
double & operator() (const Array< octave_idx_type > &ra_idx)
 Size of the specified dimension. More...
 
crefT operator() (octave_idx_type n) const
 Size of the specified dimension. More...
 
crefT operator() (octave_idx_type i, octave_idx_type j) const
 Size of the specified dimension. More...
 
crefT operator() (octave_idx_type i, octave_idx_type j, octave_idx_type k) const
 Size of the specified dimension. More...
 
crefT operator() (const Array< octave_idx_type > &ra_idx) const
 Size of the specified dimension. More...
 
Array< double, Alloccolumn (octave_idx_type k) const
 Extract column: A(:,k+1). More...
 
Array< double, Allocpage (octave_idx_type k) const
 Extract page: A(:,:,k+1). More...
 
Array< double, Alloclinear_slice (octave_idx_type lo, octave_idx_type up) const
 Extract a slice from this array as a column vector: A(:)(lo+1:up). More...
 
Array< double, Allocreshape (octave_idx_type nr, octave_idx_type nc) const
 Size of the specified dimension. More...
 
Array< double, Allocreshape (const dim_vector &new_dims) const
 Size of the specified dimension. More...
 
Array< double, Allocpermute (const Array< octave_idx_type > &vec, bool inv=false) const
 Size of the specified dimension. More...
 
Array< double, Allocipermute (const Array< octave_idx_type > &vec) const
 Size of the specified dimension. More...
 
bool issquare () const
 Size of the specified dimension. More...
 
bool isempty () const
 Size of the specified dimension. More...
 
bool isvector () const
 Size of the specified dimension. More...
 
bool is_nd_vector () const
 Size of the specified dimension. More...
 
Array< double, Alloctranspose () const
 Size of the specified dimension. More...
 
Array< double, Allochermitian (double(*fcn)(const double &)=nullptr) const
 Size of the specified dimension. More...
 
const double * data () const
 Size of the specified dimension. More...
 
double * fortran_vec ()
 Size of the specified dimension. More...
 
bool is_shared () const
 Size of the specified dimension. More...
 
int ndims () const
 Size of the specified dimension. More...
 
Array< double, Allocindex (const octave::idx_vector &i) const
 Indexing without resizing. More...
 
Array< double, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j) const
 Size of the specified dimension. More...
 
Array< double, Allocindex (const Array< octave::idx_vector > &ia) const
 Size of the specified dimension. More...
 
Array< double, Allocindex (const octave::idx_vector &i, bool resize_ok, const double &rfv) const
 Indexing with possible resizing and fill. More...
 
Array< double, Allocindex (const octave::idx_vector &i, bool resize_ok) const
 Size of the specified dimension. More...
 
Array< double, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok, const double &rfv) const
 Size of the specified dimension. More...
 
Array< double, Allocindex (const octave::idx_vector &i, const octave::idx_vector &j, bool resize_ok) const
 Size of the specified dimension. More...
 
Array< double, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok, const double &rfv) const
 Size of the specified dimension. More...
 
Array< double, Allocindex (const Array< octave::idx_vector > &ia, bool resize_ok) const
 Size of the specified dimension. More...
 
virtual double resize_fill_value () const
 Size of the specified dimension. More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc, const double &rfv)
 Resizing (with fill). More...
 
void resize2 (octave_idx_type nr, octave_idx_type nc)
 Size of the specified dimension. More...
 
void resize1 (octave_idx_type n, const double &rfv)
 Size of the specified dimension. More...
 
void resize1 (octave_idx_type n)
 Size of the specified dimension. More...
 
void resize (const dim_vector &dv, const double &rfv)
 Size of the specified dimension. More...
 
void resize (const dim_vector &dv)
 Size of the specified dimension. More...
 
void assign (const octave::idx_vector &i, const Array< double, Alloc > &rhs, const double &rfv)
 Indexed assignment (always with resize & fill). More...
 
void assign (const octave::idx_vector &i, const Array< double, Alloc > &rhs)
 Size of the specified dimension. More...
 
void assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< double, Alloc > &rhs, const double &rfv)
 Size of the specified dimension. More...
 
void assign (const octave::idx_vector &i, const octave::idx_vector &j, const Array< double, Alloc > &rhs)
 Size of the specified dimension. More...
 
void assign (const Array< octave::idx_vector > &ia, const Array< double, Alloc > &rhs, const double &rfv)
 Size of the specified dimension. More...
 
void assign (const Array< octave::idx_vector > &ia, const Array< double, Alloc > &rhs)
 Size of the specified dimension. More...
 
void delete_elements (const octave::idx_vector &i)
 Deleting elements. More...
 
void delete_elements (int dim, const octave::idx_vector &i)
 A(:,...,I,...,:) = [] (>= 2 subscripts, one of them is non-colon) More...
 
void delete_elements (const Array< octave::idx_vector > &ia)
 Dispatcher to the above two. More...
 
Array< double, Alloc > & insert (const Array< double, Alloc > &a, const Array< octave_idx_type > &idx)
 Insert an array into another at a specified position. More...
 
Array< double, Alloc > & insert (const Array< double, Alloc > &a, octave_idx_type r, octave_idx_type c)
 This is just a special case for idx = [r c 0 ...]. More...
 
void maybe_economize ()
 Size of the specified dimension. More...
 
void print_info (std::ostream &os, const std::string &prefix) const
 Size of the specified dimension. More...
 
Array< double, Allocsort (int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension. More...
 
Array< double, Allocsort (Array< octave_idx_type > &sidx, int dim=0, sortmode mode=ASCENDING) const
 Size of the specified dimension. More...
 
sortmode issorted (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
Array< octave_idx_typesort_rows_idx (sortmode mode=ASCENDING) const
 Sort by rows returns only indices. More...
 
sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 Ordering is auto-detected or can be specified. More...
 
octave_idx_type lookup (const double &value, sortmode mode=UNSORTED) const
 Do a binary lookup in a sorted array. More...
 
Array< octave_idx_typelookup (const Array< double, Alloc > &values, sortmode mode=UNSORTED) const
 Ditto, but for an array of values, specializing on the case when values are sorted. More...
 
octave_idx_type nnz () const
 Count nonzero elements. More...
 
Array< octave_idx_typefind (octave_idx_type n=-1, bool backward=false) const
 Find indices of (at most n) nonzero elements. More...
 
Array< double, Allocnth_element (const octave::idx_vector &n, int dim=0) const
 Returns the n-th element in increasing order, using the same ordering as used for sort. More...
 
Array< double, Allocdiag (octave_idx_type k=0) const
 Get the kth super or subdiagonal. More...
 
Array< double, Allocdiag (octave_idx_type m, octave_idx_type n) const
 Size of the specified dimension. More...
 
Array< U, Amap (F fcn) const
 Apply function fcn to each element of the Array<T, Alloc>. More...
 
Array< U, Amap (U(&fcn)(double)) const
 Overloads for function references. More...
 
Array< U, Amap (U(&fcn)(const double &)) const
 Size of the specified dimension. More...
 
bool test (F fcn) const
 Generic any/all test functionality with arbitrary predicate. More...
 
bool test_any (F fcn) const
 Simpler calls. More...
 
bool test_any (bool(&fcn)(double)) const
 Overloads for function references. More...
 
bool test_any (bool(&fcn)(const double &)) const
 Size of the specified dimension. More...
 
bool test_all (F fcn) const
 Size of the specified dimension. More...
 
bool test_all (bool(&fcn)(double)) const
 Size of the specified dimension. More...
 
bool test_all (bool(&fcn)(const double &)) const
 Size of the specified dimension. More...
 
bool optimize_dimensions (const dim_vector &dv)
 Returns true if this->dims () == dv, and if so, replaces this->m_dimensions by a shallow copy of dv. More...
 

Friends

ColumnVector imag (const ComplexColumnVector &a)
 
ColumnVector operator* (const DiagMatrix &a, const ColumnVector &b)
 
ColumnVector operator* (const Matrix &a, const ColumnVector &b)
 
std::ostream & operator<< (std::ostream &os, const ColumnVector &a)
 
std::istream & operator>> (std::istream &is, ColumnVector &a)
 
ColumnVector real (const ComplexColumnVector &a)
 

Additional Inherited Members

- Public Types inherited from Array< double >
typedef bool(* compare_fcn_type) (typename ref_param< double >::type, typename ref_param< double >::type)
 
typedef ref_param< double >::type crefT
 
typedef double element_type
 
typedef octave_idx_type size_type
 Used for operator(), and returned by numel() and size() (beware: signed integer) More...
 
typedef double value_type
 
- Static Public Member Functions inherited from Array< double >
static Array< double, Alloccat (int dim, octave_idx_type n, const Array< double, Alloc > *array_list)
 Concatenation along a specified (0-based) dimension, equivalent to cat(). More...
 
- Protected Member Functions inherited from Array< double >
 Array (const Array< double, Alloc > &a, const dim_vector &dv, octave_idx_type l, octave_idx_type u)
 slice constructor More...
 
- Protected Attributes inherited from Array< double >
dim_vector m_dimensions
 
Array< double, Alloc >::ArrayRep * m_rep
 
double * m_slice_data
 
octave_idx_type m_slice_len
 

Detailed Description

Definition at line 34 of file dColVector.h.

Constructor & Destructor Documentation

◆ ColumnVector() [1/7]

ColumnVector::ColumnVector ( )
inline

Definition at line 40 of file dColVector.h.

◆ ColumnVector() [2/7]

ColumnVector::ColumnVector ( octave_idx_type  n)
inlineexplicit

Definition at line 42 of file dColVector.h.

◆ ColumnVector() [3/7]

ColumnVector::ColumnVector ( const dim_vector dv)
inlineexplicit

Definition at line 45 of file dColVector.h.

◆ ColumnVector() [4/7]

ColumnVector::ColumnVector ( octave_idx_type  n,
double  val 
)
inline

Definition at line 48 of file dColVector.h.

◆ ColumnVector() [5/7]

ColumnVector::ColumnVector ( const ColumnVector a)
inline

Definition at line 51 of file dColVector.h.

◆ ColumnVector() [6/7]

ColumnVector::ColumnVector ( const MArray< double > &  a)
inline

Definition at line 53 of file dColVector.h.

◆ ColumnVector() [7/7]

ColumnVector::ColumnVector ( const Array< double > &  a)
inline

Definition at line 54 of file dColVector.h.

◆ ~ColumnVector()

ColumnVector::~ColumnVector ( )
default

Member Function Documentation

◆ abs()

ColumnVector ColumnVector::abs ( ) const

Definition at line 131 of file dColVector.cc.

◆ clear()

void ColumnVector::clear ( octave_idx_type  n)
inline

Definition at line 119 of file dColVector.h.

References Array< T, Alloc >::clear(), and n.

◆ extract()

ColumnVector ColumnVector::extract ( octave_idx_type  r1,
octave_idx_type  r2 
) const

◆ extract_n()

ColumnVector ColumnVector::extract_n ( octave_idx_type  r1,
octave_idx_type  n 
) const

Definition at line 166 of file dColVector.cc.

References Array< double >::elem(), n, and Array< T, Alloc >::xelem().

Referenced by xform2cam().

◆ fill() [1/2]

ColumnVector & ColumnVector::fill ( double  val)

Definition at line 77 of file dColVector.cc.

◆ fill() [2/2]

ColumnVector & ColumnVector::fill ( double  val,
octave_idx_type  r1,
octave_idx_type  r2 
)

◆ insert()

◆ max()

double ColumnVector::max ( ) const

◆ min()

double ColumnVector::min ( ) const

Definition at line 245 of file dColVector.cc.

References Array< double >::elem(), len, and Array< double >::numel().

Referenced by is_coplanar(), and DiagMatrix::rcond().

◆ operator!=()

bool ColumnVector::operator!= ( const ColumnVector a) const

Definition at line 52 of file dColVector.cc.

◆ operator=()

ColumnVector& ColumnVector::operator= ( const ColumnVector a)
inline

Definition at line 56 of file dColVector.h.

References MArray< T >::operator=().

◆ operator==()

bool ColumnVector::operator== ( const ColumnVector a) const

◆ resize()

void ColumnVector::resize ( octave_idx_type  n,
const double &  rfv = 0 
)
inline

◆ stack()

ColumnVector ColumnVector::stack ( const ColumnVector a) const

Definition at line 114 of file dColVector.cc.

References insert(), len, Array< T, Alloc >::numel(), and Array< double >::numel().

◆ transpose()

RowVector ColumnVector::transpose ( ) const

Definition at line 125 of file dColVector.cc.

References MArray< T >::transpose().

Referenced by xform2cam().

Friends And Related Function Documentation

◆ imag

ColumnVector imag ( const ComplexColumnVector a)
friend

Definition at line 143 of file dColVector.cc.

◆ operator* [1/2]

ColumnVector operator* ( const DiagMatrix a,
const ColumnVector b 
)
friend

Definition at line 214 of file dColVector.cc.

◆ operator* [2/2]

ColumnVector operator* ( const Matrix a,
const ColumnVector b 
)
friend

Definition at line 179 of file dColVector.cc.

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const ColumnVector a 
)
friend

Definition at line 276 of file dColVector.cc.

◆ operator>>

std::istream& operator>> ( std::istream &  is,
ColumnVector a 
)
friend

Definition at line 286 of file dColVector.cc.

◆ real

ColumnVector real ( const ComplexColumnVector a)
friend

Definition at line 137 of file dColVector.cc.


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