PineForge unreleased
Deterministic PineScript v6 backtest runtime — C ABI reference
Loading...
Searching...
No Matches
Data Structures | Public Member Functions | Static Public Member Functions
pineforge::GenericMatrix< T > Class Template Reference

#include <generic_matrix.hpp>

Data Structures

class  Snapshot
 

Public Member Functions

 GenericMatrix () noexcept=default
 
 GenericMatrix (const GenericMatrix &) noexcept=default
 
GenericMatrix & operator= (const GenericMatrix &) noexcept=default
 
 GenericMatrix (GenericMatrix &&other) noexcept
 
GenericMatrix & operator= (GenericMatrix &&other) noexcept
 
 ~GenericMatrix ()=default
 
T get (int row, int col) const
 
void set (int row, int col, T val)
 
void fill (T val)
 
int rows () const
 
int columns () const
 
std::vector< T > row (int idx) const
 
std::vector< T > col (int idx) const
 
template<typename U = T, typename = std::enable_if_t<!std::is_same_v<U, bool>>>
const std::vector< T > & row_ref (int idx) const
 
void add_row (int idx, const std::vector< T > &values)
 
void add_col (int idx, const std::vector< T > &values)
 
void remove_row (int idx)
 
void remove_col (int idx)
 
void swap_rows (int i, int j)
 
void swap_columns (int i, int j)
 
GenericMatrix copy () const
 
GenericMatrix submatrix (int from_row, int to_row, int from_col, int to_col) const
 
GenericMatrix transpose () const
 
GenericMatrix concat (const GenericMatrix &other, bool horizontal) const
 
void reshape (int new_rows, int new_cols)
 
void reverse ()
 
void sort (int column, bool ascending=true)
 
int elements_count () const
 
bool is_na () const noexcept
 
Snapshot snapshot () const
 
void restore (const Snapshot &snapshot)
 

Static Public Member Functions

static GenericMatrix new_ (int rows, int cols, T init)
 
static GenericMatrix new_ (int rows, int cols)
 

Detailed Description

template<typename T>
class pineforge::GenericMatrix< T >

Definition at line 164 of file generic_matrix.hpp.

Constructor & Destructor Documentation

◆ GenericMatrix() [1/3]

template<typename T>
pineforge::GenericMatrix< T >::GenericMatrix ( )
defaultnoexcept

Referenced by copy(), pineforge::GenericMatrix< bool >::copy(), new_(), new_(), pineforge::GenericMatrix< bool >::new_(), submatrix(), pineforge::GenericMatrix< bool >::submatrix(), transpose(), and pineforge::GenericMatrix< bool >::transpose().

◆ GenericMatrix() [2/3]

template<typename T>
pineforge::GenericMatrix< T >::GenericMatrix ( const GenericMatrix< T > & )
defaultnoexcept

◆ GenericMatrix() [3/3]

template<typename T>
pineforge::GenericMatrix< T >::GenericMatrix ( GenericMatrix< T > && other)
inlinenoexcept

Definition at line 206 of file generic_matrix.hpp.

◆ ~GenericMatrix()

template<typename T>
pineforge::GenericMatrix< T >::~GenericMatrix ( )
default

Member Function Documentation

◆ operator=() [1/2]

template<typename T>
GenericMatrix & pineforge::GenericMatrix< T >::operator= ( const GenericMatrix< T > & )
defaultnoexcept

◆ operator=() [2/2]

template<typename T>
GenericMatrix & pineforge::GenericMatrix< T >::operator= ( GenericMatrix< T > && other)
inlinenoexcept

Definition at line 208 of file generic_matrix.hpp.

◆ new_() [1/2]

template<typename T>
static GenericMatrix pineforge::GenericMatrix< T >::new_ ( int rows,
int cols,
T init )
inlinestaticnodiscard

Definition at line 234 of file generic_matrix.hpp.

References GenericMatrix(), pineforge::detail::matrix_call_error(), and rows().

Referenced by pineforge::GenericMatrix< bool >::new_().

◆ new_() [2/2]

template<typename T>
static GenericMatrix pineforge::GenericMatrix< T >::new_ ( int rows,
int cols )
inlinestaticnodiscard

Definition at line 244 of file generic_matrix.hpp.

References GenericMatrix(), pineforge::detail::matrix_call_error(), and rows().

◆ get()

template<typename T>
T pineforge::GenericMatrix< T >::get ( int row,
int col ) const
inline

Definition at line 256 of file generic_matrix.hpp.

References col(), columns(), pineforge::detail::matrix_call_error(), row(), and rows().

◆ set()

template<typename T>
void pineforge::GenericMatrix< T >::set ( int row,
int col,
T val )
inline

Definition at line 269 of file generic_matrix.hpp.

References col(), columns(), pineforge::detail::matrix_call_error(), row(), and rows().

◆ fill()

template<typename T>
void pineforge::GenericMatrix< T >::fill ( T val)
inline

Definition at line 282 of file generic_matrix.hpp.

◆ rows()

template<typename T>
int pineforge::GenericMatrix< T >::rows ( ) const
inline

Definition at line 286 of file generic_matrix.hpp.

Referenced by add_row(), pineforge::GenericMatrix< bool >::add_row(), concat(), pineforge::GenericMatrix< bool >::concat(), get(), pineforge::GenericMatrix< bool >::get(), new_(), new_(), remove_row(), pineforge::GenericMatrix< bool >::remove_row(), row(), pineforge::GenericMatrix< bool >::row(), row_ref(), set(), pineforge::GenericMatrix< bool >::set(), submatrix(), pineforge::GenericMatrix< bool >::submatrix(), swap_rows(), pineforge::GenericMatrix< bool >::swap_rows(), transpose(), and pineforge::GenericMatrix< bool >::transpose().

◆ columns()

template<typename T>
int pineforge::GenericMatrix< T >::columns ( ) const
inline

Definition at line 289 of file generic_matrix.hpp.

Referenced by add_col(), pineforge::GenericMatrix< bool >::add_col(), add_row(), col(), pineforge::GenericMatrix< bool >::col(), concat(), pineforge::GenericMatrix< bool >::concat(), get(), pineforge::GenericMatrix< bool >::get(), remove_col(), pineforge::GenericMatrix< bool >::remove_col(), set(), pineforge::GenericMatrix< bool >::set(), submatrix(), pineforge::GenericMatrix< bool >::submatrix(), swap_columns(), pineforge::GenericMatrix< bool >::swap_columns(), transpose(), and pineforge::GenericMatrix< bool >::transpose().

◆ row()

template<typename T>
std::vector< T > pineforge::GenericMatrix< T >::row ( int idx) const
inline

Definition at line 294 of file generic_matrix.hpp.

References pineforge::detail::matrix_call_error(), and rows().

Referenced by add_col(), get(), pineforge::GenericMatrix< bool >::get(), set(), and pineforge::GenericMatrix< bool >::set().

◆ col()

template<typename T>
std::vector< T > pineforge::GenericMatrix< T >::col ( int idx) const
inline

Definition at line 303 of file generic_matrix.hpp.

References columns(), and pineforge::detail::matrix_call_error().

Referenced by get(), pineforge::GenericMatrix< bool >::get(), set(), and pineforge::GenericMatrix< bool >::set().

◆ row_ref()

template<typename T>
template<typename U = T, typename = std::enable_if_t<!std::is_same_v<U, bool>>>
const std::vector< T > & pineforge::GenericMatrix< T >::row_ref ( int idx) const
inline

Definition at line 317 of file generic_matrix.hpp.

References pineforge::detail::matrix_call_error(), and rows().

◆ add_row()

template<typename T>
void pineforge::GenericMatrix< T >::add_row ( int idx,
const std::vector< T > & values )
inline

Definition at line 326 of file generic_matrix.hpp.

References columns(), pineforge::detail::matrix_call_error(), and rows().

◆ add_col()

template<typename T>
void pineforge::GenericMatrix< T >::add_col ( int idx,
const std::vector< T > & values )
inline

Definition at line 340 of file generic_matrix.hpp.

References columns(), pineforge::detail::matrix_call_error(), and row().

◆ remove_row()

template<typename T>
void pineforge::GenericMatrix< T >::remove_row ( int idx)
inline

Definition at line 365 of file generic_matrix.hpp.

References pineforge::detail::erase_row(), pineforge::detail::matrix_call_error(), and rows().

◆ remove_col()

template<typename T>
void pineforge::GenericMatrix< T >::remove_col ( int idx)
inline

Definition at line 374 of file generic_matrix.hpp.

References columns(), pineforge::detail::erase_col(), and pineforge::detail::matrix_call_error().

◆ swap_rows()

template<typename T>
void pineforge::GenericMatrix< T >::swap_rows ( int i,
int j )
inline

Definition at line 383 of file generic_matrix.hpp.

References pineforge::detail::matrix_call_error(), rows(), and pineforge::detail::swap_rows_impl().

◆ swap_columns()

template<typename T>
void pineforge::GenericMatrix< T >::swap_columns ( int i,
int j )
inline

Definition at line 392 of file generic_matrix.hpp.

References columns(), pineforge::detail::matrix_call_error(), and pineforge::detail::swap_cols_impl().

◆ copy()

template<typename T>
GenericMatrix pineforge::GenericMatrix< T >::copy ( ) const
inlinenodiscard

Definition at line 401 of file generic_matrix.hpp.

References GenericMatrix().

Referenced by concat(), and pineforge::GenericMatrix< bool >::concat().

◆ submatrix()

template<typename T>
GenericMatrix pineforge::GenericMatrix< T >::submatrix ( int from_row,
int to_row,
int from_col,
int to_col ) const
inlinenodiscard

Definition at line 405 of file generic_matrix.hpp.

References columns(), pineforge::detail::copy_submatrix(), GenericMatrix(), pineforge::detail::matrix_call_error(), and rows().

◆ transpose()

template<typename T>
GenericMatrix pineforge::GenericMatrix< T >::transpose ( ) const
inlinenodiscard

Definition at line 429 of file generic_matrix.hpp.

References columns(), GenericMatrix(), rows(), and pineforge::detail::transpose_impl().

◆ concat()

template<typename T>
GenericMatrix pineforge::GenericMatrix< T >::concat ( const GenericMatrix< T > & other,
bool horizontal ) const
inlinenodiscard

Definition at line 436 of file generic_matrix.hpp.

References columns(), pineforge::detail::concat_impl(), copy(), pineforge::detail::matrix_call_error(), and rows().

◆ reshape()

template<typename T>
void pineforge::GenericMatrix< T >::reshape ( int new_rows,
int new_cols )
inline

Definition at line 455 of file generic_matrix.hpp.

References pineforge::detail::reshape_impl().

◆ reverse()

template<typename T>
void pineforge::GenericMatrix< T >::reverse ( )
inline

Definition at line 461 of file generic_matrix.hpp.

◆ sort()

template<typename T>
void pineforge::GenericMatrix< T >::sort ( int column,
bool ascending = true )
inline

Definition at line 466 of file generic_matrix.hpp.

References pineforge::detail::sort_impl().

◆ elements_count()

template<typename T>
int pineforge::GenericMatrix< T >::elements_count ( ) const
inline

Definition at line 474 of file generic_matrix.hpp.

References pineforge::detail::elements_count_impl().

◆ is_na()

template<typename T>
bool pineforge::GenericMatrix< T >::is_na ( ) const
inlinenodiscardnoexcept

Definition at line 478 of file generic_matrix.hpp.

◆ snapshot()

template<typename T>
Snapshot pineforge::GenericMatrix< T >::snapshot ( ) const
inlinenodiscard

Definition at line 480 of file generic_matrix.hpp.

Referenced by restore().

◆ restore()

template<typename T>
void pineforge::GenericMatrix< T >::restore ( const Snapshot & snapshot)
inline

Definition at line 485 of file generic_matrix.hpp.

References pineforge::detail::matrix_snapshot_error(), and snapshot().

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