feisty meow concerns codebase  2.140
structures::double_matrix Class Reference

A matrix of double floating point numbers. More...

#include <matrix.h>

Inheritance diagram for structures::double_matrix:
Collaboration diagram for structures::double_matrix:

Public Member Functions

 double_matrix (int rows=0, int cols=0, double *data=NULL_POINTER)
 
 double_matrix (const matrix< double > &to_copy)
 
- Public Member Functions inherited from structures::matrix< double >
 matrix (int rows=0, int cols=0, double *data=NULL_POINTER)
 the "data" array must have at least "rows" * "cols" contents in it. More...
 
 matrix (const matrix &to_copy)
 
 ~matrix ()
 
int rows () const
 
int columns () const
 
matrixoperator= (const matrix &to_copy)
 
double & get (int row, int column)
 
const double & get (int row, int column) const
 retrieves the contents from the specified "row" and "column". More...
 
bool put (int row, int column, const double &to_put)
 stores "to_put" into the matrix at "row" and "column". More...
 
double * operator[] (int row)
 dangerous: indexes by "row" into the underlying contents. More...
 
const double * operator[] (int row) const
 dangerous: constant peek into data for "row" in underlying contents. More...
 
matrix submatrix (int row, int column, int rows, int columns) const
 returns a submatrix of this one starting at "row" and "column". More...
 
void submatrix (matrix &sub, int row, int column, int rows, int cols) const
 like submatrix() above, but stores into the "sub" parameter. More...
 
matrix transpose () const
 provides the transposed form of this matrix. More...
 
void transpose (matrix &resultant) const
 stores the transpose of this matrix in "resultant". More...
 
basis::array< double > get_row (int row)
 return the vector at the "row", or an empty array if "row" is invalid. More...
 
basis::array< double > get_column (int column)
 return the vector at the "column", or an empty array if it's invalid. More...
 
bool insert_row (int before_row)
 inserts a row before the "before_" parameter. More...
 
bool insert_column (int before_column)
 inserts a column before the "before_" parameter. More...
 
void reset (int rows=0, int columns=0)
 empties the matrix and changes its size. More...
 
void redimension (int new_rows, int new_columns)
 changes the size to contain "new_rows" by "new_columns" elements. More...
 
bool zap_row (int row_to_zap)
 
bool zap_column (int column_to_zap)
 removes a row or column from the matrix. More...
 

Additional Inherited Members

- Protected Types inherited from basis::array< double >
enum  specialc_flags
 the flags specify how the array treats its contents and its length. More...
 
enum  how_to_copy
 
enum  shift_directions
 
- Protected Member Functions inherited from basis::array< double >
 DEFINE_CLASS_NAME ("array")
 
 array (int number=0, const double *init=NULL_POINTER, int flags=EXPONENTIAL_GROWTH|FLUSH_INVISIBLE)
 Constructs an array with room for "number" objects. More...
 
 array (const array< double > &copy_from)
 copies the contents & sizing information from "copy_from". More...
 
virtual ~array ()
 destroys the memory allocated for the objects. More...
 
void reset (int number=0, const double *initial_contents=NULL_POINTER)
 Resizes this array and sets the contents from an array of contents. More...
 
arrayoperator= (const array< double > &copy_from)
 Copies the array in "copy_from" into this. More...
 
int length () const
 Returns the current reported length of the allocated C array. More...
 
int last () const
 Returns the last valid element in the array. More...
 
int flags () const
 Provides the raw flags value, without interpreting what it means. More...
 
bool exponential () const
 Returns true if this allocator will grow exponentially on resize. More...
 
bool simple () const
 Reports whether the templated object is a simple type or not. More...
 
const double & get (int index) const
 Accesses individual objects stored in "this" at the "index" position. More...
 
double & use (int index)
 A non-constant version of get(); the returned object can be modified. More...
 
const double & operator[] (int index) const
 Synonym for get that provides the expected array indexing syntax. More...
 
double & operator[] (int index)
 Synonym for use that provides the expected array indexing syntax. More...
 
outcome put (int index, const double &to_put)
 Stores an object at the index "index" in the array. More...
 
array concatenation (const array &to_concatenate) const
 Returns the concatenation of "this" and the array "to_concatenate". More...
 
array concatenation (const double &to_concatenate) const
 Returns the concatenation of "this" and the object "to_concatenate". More...
 
arrayconcatenate (const array &to_concatenate)
 Appends the array "to_concatenate" onto "this" and returns "this". More...
 
arrayconcatenate (const double &to_concatenate)
 Appends the object "to_concatenate" onto "this" and returns "this". More...
 
arrayconcatenate (const double *to_concatenate, int length)
 Concatenates a C-array "to_concatenate" onto "this" and returns "this". More...
 
array operator+ (const array &to_cat) const
 Synonym for concatenation. More...
 
array operator+ (const double &to_concatenate) const
 Synonym for concatenation. More...
 
arrayoperator+= (const array &to_concatenate)
 Synonym for concatenate that modifies "this". More...
 
arrayoperator+= (const double &to_concatenate)
 Synonym for concatenate that modifies "this". More...
 
const double * observe () const
 Returns a pointer to the underlying C array of data. More...
 
double * access ()
 A non-constant access of the underlying C-array. BE REALLY CAREFUL. More...
 
void swap_contents (array< double > &other)
 Exchanges the contents of "this" and "other". More...
 
void snarf (array &new_contents)
 Drops "this" array's contents into the dustbin and uses "new_contents". More...
 
array subarray (int start, int end) const
 Returns the array segment between the indices "start" and "end". More...
 
outcome insert (int index, int new_indices)
 Adds "new_indices" new positions for objects into the array at "index". More...
 
outcome overwrite (int index, const array &write_with, int count=-1)
 Stores the array "write_with" into the current array at the "index". More...
 
outcome stuff (int length, double *to_stuff) const
 Copies at most "length" elements from this into the array "to_stuff". More...
 
outcome resize (int new_size, how_to_copy way=NEW_AT_END)
 Changes the size of the C array to "new_size". More...
 
outcome zap (int start, int end)
 Deletes from "this" the objects inclusively between "start" and "end". More...
 
outcome shrink ()
 Cuts loose any allocated space that is beyond the real length. More...
 
outcome retrain (int new_size, const double *to_copy)
 Resizes the C array and stuffs it with the contents in "to_copy". More...
 
void shift_data (shift_directions where)
 The valid portion of the array is moved to the left or right. More...
 
int internal_real_length () const
 Gritty Internal: the real allocated length. More...
 
int internal_offset () const
 Gritty Internal: the offset from real start to stored data. More...
 
const double * internal_block_start () const
 Gritty Internal: constant peek at the real allocated pointer. More...
 
double * internal_block_start ()
 Gritty Internal: the real allocated pointer made accessible. More...
 
double *const * internal_offset_mem () const
 Gritty Internal: the start of the actual stored data. More...
 

Detailed Description

A matrix of double floating point numbers.

Definition at line 129 of file matrix.h.

Constructor & Destructor Documentation

◆ double_matrix() [1/2]

structures::double_matrix::double_matrix ( int  rows = 0,
int  cols = 0,
double *  data = NULL_POINTER 
)
inline

Definition at line 132 of file matrix.h.

◆ double_matrix() [2/2]

structures::double_matrix::double_matrix ( const matrix< double > &  to_copy)
inline

Definition at line 134 of file matrix.h.


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