Col< eT > Class Template Reference
[Col]

Class for column vectors (matrices with only column). More...

#include <Col_proto.hpp>

Inheritance diagram for Col< eT >:
Mat< eT > BaseVec< eT, Col< eT > > Base< eT, Mat< eT > >

List of all members.

Public Types

typedef eT elem_type
 the type of elements stored in the matrix
typedef get_pod_type
< elem_type >::pod_type 
pod_type
 if eT is std::complex, pod_type is the underlying type used by std::complex. < otherwise pod_type is the same as elem_type

Public Member Functions

 Col ()
 construct an empty column vector
 Col (const u32 n_elem)
 construct a column vector with the specified number of n_elem
 Col (const u32 in_rows, const u32 in_cols)
 Col (const char *text)
 construct a column vector from specified text
const Coloperator= (const char *text)
 construct a column vector from specified text
 Col (const std::string &text)
 construct a column vector from specified text
const Coloperator= (const std::string &text)
 construct a column vector from specified text
 Col (const Col &X)
 construct a column vector from a given column vector
const Coloperator= (const Col &X)
 construct a column vector from a given column vector
 Col (const Mat< eT > &X)
 construct a column vector from a given matrix; the matrix must have exactly one column
const Coloperator= (const Mat< eT > &X)
 construct a column vector from a given matrix; the matrix must have exactly one column
const Coloperator*= (const Mat< eT > &X)
 Col (eT *aux_mem, const u32 aux_n_rows, const u32 aux_n_cols, const bool copy_aux_mem=true)
 construct a column vector from a given auxiliary array of eTs
 Col (const eT *aux_mem, const u32 aux_n_rows, const u32 aux_n_cols)
 construct a column vector from a given auxiliary array of eTs
 Col (eT *aux_mem, const u32 aux_length, const bool copy_aux_mem=true)
 construct a column vector from a given auxiliary array of eTs
 Col (const eT *aux_mem, const u32 aux_length)
 construct a column vector from a given auxiliary array of eTs
template<typename T1 , typename T2 >
 Col (const Base< pod_type, T1 > &A, const Base< pod_type, T2 > &B)
 Col (const subview< eT > &X)
 construct a column vector from given a submatrix; the submatrix must have exactly one column
const Coloperator= (const subview< eT > &X)
 construct a column vector from given a submatrix; the submatrix must have exactly one column
const Coloperator*= (const subview< eT > &X)
 in-place matrix mutiplication (using a submatrix on the right-hand-side)
 Col (const subview_cube< eT > &X)
 construct a column vector from given a subcube; the subcube must have exactly one column
const Coloperator= (const subview_cube< eT > &X)
 construct a column vector from given a subcube; the subcube must have exactly one column
const Coloperator*= (const subview_cube< eT > &X)
 in-place matrix mutiplication (using a single-slice subcube on the right-hand-side)
 Col (const diagview< eT > &X)
 construct a column vector from given a diagview
const Coloperator= (const diagview< eT > &X)
 construct a column vector from given a diagview
const Coloperator*= (const diagview< eT > &X)
arma_inline eT & row (const u32 row_num)
 creation of subview (row vector)
arma_inline eT row (const u32 row_num) const
 creation of subview (row vector)
arma_inline subview_col< eT > rows (const u32 in_row1, const u32 in_row2)
 creation of subview (submatrix comprised of specified row vectors)
arma_inline const subview_col< eT > rows (const u32 in_row1, const u32 in_row2) const
 creation of subview (submatrix comprised of specified row vectors)
template<typename T1 , typename op_type >
 Col (const Op< T1, op_type > &X)
 construct a column vector from Op, i.e. run the previously delayed operations; the result of the operations must have exactly one column
template<typename T1 , typename op_type >
const Coloperator= (const Op< T1, op_type > &X)
 construct a column vector from Op, i.e. run the previously delayed operations; the result of the operations must have exactly one column
template<typename T1 , typename op_type >
const Coloperator*= (const Op< T1, op_type > &X)
 in-place matrix multiplication, with the right-hand-side operand having delayed operations
template<typename T1 , typename T2 , typename glue_type >
 Col (const Glue< T1, T2, glue_type > &X)
 construct a column vector from Glue, i.e. run the previously delayed operations; the result of the operations must have exactly one column
template<typename T1 , typename T2 , typename glue_type >
const Coloperator= (const Glue< T1, T2, glue_type > &X)
 construct a column vector from Glue, i.e. run the previously delayed operations; the result of the operations must have exactly one column
template<typename T1 , typename T2 , typename glue_type >
const Coloperator*= (const Glue< T1, T2, glue_type > &X)
 in-place matrix multiplications, with the right-hand-side operands having delayed operations
void set_size (const u32 n_elem)
 change the number of rows
void set_size (const u32 n_rows, const u32 n_cols)
 change the number of rows (this function re-implements mat::set_size() in order to check the number of columns)
template<typename eT2 >
void copy_size (const Mat< eT2 > &m)
 change the number of rows (this function re-implements mat::copy_size() in order to check the number of columns)
void zeros ()
void zeros (const u32 n_elem)
void zeros (const u32 n_rows, const u32 n_cols)
void ones ()
void ones (const u32 n_elem)
void ones (const u32 n_rows, const u32 n_cols)
void load (const std::string name, const file_type type=auto_detect)
 load a matrix from a file

Detailed Description

template<typename eT>
class Col< eT >

Class for column vectors (matrices with only column).

Definition at line 22 of file Col_proto.hpp.


Member Typedef Documentation

template<typename eT>
typedef eT Col< eT >::elem_type

the type of elements stored in the matrix

Reimplemented from Mat< eT >.

Definition at line 26 of file Col_proto.hpp.

template<typename eT>
typedef get_pod_type<elem_type>::pod_type Col< eT >::pod_type

if eT is std::complex, pod_type is the underlying type used by std::complex. < otherwise pod_type is the same as elem_type

Reimplemented from Mat< eT >.

Definition at line 27 of file Col_proto.hpp.