GNU Octave  9.1.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
Public Member Functions | Protected Member Functions | List of all members
octave_base_int_matrix< T > Class Template Reference

#include "ov-base-int.h"

Inheritance diagram for octave_base_int_matrix< T >:
octave_base_matrix< T > octave_base_value

Public Member Functions

 octave_base_int_matrix ()
 
 octave_base_int_matrix (const T &nda)
 
 ~octave_base_int_matrix ()=default
 
octave_value as_double () const
 
octave_value as_int16 () const
 
octave_value as_int32 () const
 
octave_value as_int64 () const
 
octave_value as_int8 () const
 
octave_value as_single () const
 
octave_value as_uint16 () const
 
octave_value as_uint32 () const
 
octave_value as_uint64 () const
 
octave_value as_uint8 () const
 
octave_base_value * clone () const
 
octave_value convert_to_str_internal (bool, bool, char type) const
 
std::string edit_display (const float_display_format &fmt, octave_idx_type i, octave_idx_type j) const
 
octave_base_value * empty_clone () const
 
bool isreal () const
 
bool load_ascii (std::istream &is)
 
bool load_binary (std::istream &is, bool swap, octave::mach_info::float_format)
 
void print_raw (std::ostream &os, bool pr_as_read_syntax=false) const
 
bool save_ascii (std::ostream &os)
 
bool save_binary (std::ostream &os, bool)
 
octave_base_value * try_narrowing_conversion ()
 
- Public Member Functions inherited from octave_base_matrix< T >
 octave_base_matrix ()
 
 octave_base_matrix (const octave_base_matrix &m)
 
 octave_base_matrix (const T &m, const MatrixType &t=MatrixType())
 
 ~octave_base_matrix ()
 
octave_value all (int dim=0) const
 
octave_value any (int dim=0) const
 
void assign (const octave_value_list &idx, const T &rhs)
 
void assign (const octave_value_list &idx, typename MT::element_type rhs)
 
virtual void assign (const std::string &, const octave_value &)
 
std::size_t byte_size () const
 
void delete_elements (const octave_value_list &idx)
 
octave_value diag (octave_idx_type k=0) const
 
octave_value diag (octave_idx_type m, octave_idx_type n) const
 
dim_vector dims () const
 
octave_value do_index_op (const octave_value_list &idx, bool resize_ok=false)
 
std::string edit_display (const float_display_format &fmt, octave_idx_type i, octave_idx_type j) const
 
octave_value fast_elem_extract (octave_idx_type n) const
 
bool fast_elem_insert (octave_idx_type n, const octave_value &x)
 
octave_value full_value () const
 
float_display_format get_edit_display_format () const
 
bool is_constant () const
 
bool is_defined () const
 
bool is_full_num_matrix () const
 
bool is_matrix_type () const
 
sortmode is_sorted_rows (sortmode mode=UNSORTED) const
 
bool is_true () const
 
bool isnumeric () const
 
sortmode issorted (sortmode mode=UNSORTED) const
 
T & matrix_ref ()
 
const T & matrix_ref () const
 
MatrixType matrix_type () const
 
MatrixType matrix_type (const MatrixType &_typ) const
 
void maybe_economize ()
 
const void * mex_get_data () const
 
int ndims () const
 
octave_idx_type nnz () const
 
octave_idx_type numel () const
 
octave_value permute (const Array< int > &vec, bool inv=false) const
 
void print (std::ostream &os, bool pr_as_read_syntax=false)
 
bool print_as_scalar () const
 
void print_info (std::ostream &os, const std::string &prefix) const
 
octave_value reshape (const dim_vector &new_dims) const
 
octave_value resize (const dim_vector &dv, bool fill=false) const
 
void short_disp (std::ostream &os) const
 
octave_value_list simple_subsref (char type, octave_value_list &idx, int nargout)
 
octave_value sort (Array< octave_idx_type > &sidx, octave_idx_type dim=0, sortmode mode=ASCENDING) const
 
octave_value sort (octave_idx_type dim=0, sortmode mode=ASCENDING) const
 
Array< octave_idx_type > sort_rows_idx (sortmode mode=ASCENDING) const
 
octave_value squeeze () const
 
octave_value subsasgn (const std::string &type, const std::list< octave_value_list > &idx, const octave_value &rhs)
 
virtual octave_value subsref (const std::string &type, const std::list< octave_value_list > &idx)
 
octave_value subsref (const std::string &type, const std::list< octave_value_list > &idx)
 
virtual octave_value subsref (const std::string &type, const std::list< octave_value_list > &idx, bool auto_add)
 
virtual octave_value_list subsref (const std::string &type, const std::list< octave_value_list > &idx, int nargout)
 
octave_value_list subsref (const std::string &type, const std::list< octave_value_list > &idx, int)
 
- Public Member Functions inherited from octave_base_value
 octave_base_value ()
 
 octave_base_value (const octave_base_value &)
 
virtual ~octave_base_value ()=default
 
virtual NDArray array_value (bool=false) const
 
virtual octave_value as_double_or_copy ()
 
virtual mxArray * as_mxArray (bool interleaved) const
 
virtual void assign (const std::string &, const octave_value &)
 
virtual boolNDArray bool_array_value (bool=false) const
 
virtual boolMatrix bool_matrix_value (bool=false) const
 
virtual bool bool_value (bool=false) const
 
virtual void break_closure_cycles (const std::shared_ptr< octave::stack_frame > &)
 
virtual builtin_type_t builtin_type () const
 
virtual void call_object_destructor ()
 
virtual Cell cell_value () const
 
virtual Array< std::string > cellstr_value () const
 
virtual charNDArray char_array_value (bool=false) const
 
virtual charMatrix char_matrix_value (bool force=false) const
 
virtual std::string class_name () const
 
virtual octave_classdef * classdef_object_value (bool silent=false)
 
octave_idx_type columns () const
 
virtual ComplexNDArray complex_array_value (bool=false) const
 
virtual ComplexDiagMatrix complex_diag_matrix_value (bool=false) const
 
virtual ComplexMatrix complex_matrix_value (bool=false) const
 
virtual Complex complex_value (bool=false) const
 
virtual void convert_to_row_or_column_vector ()
 
virtual octave_value convert_to_str (bool pad=false, bool force=false, char type='\'') const
 
virtual DiagMatrix diag_matrix_value (bool=false) const
 
virtual double double_value (bool=false) const
 
virtual octave_value dump () const
 
virtual void erase_subfunctions ()
 
virtual bool fast_elem_insert_self (void *where, builtin_type_t btyp) const
 
virtual octave_fcn_handle * fcn_handle_value (bool silent=false)
 
virtual octave_base_value * find_parent_class (const std::string &)
 
virtual FloatNDArray float_array_value (bool=false) const
 
virtual FloatComplexNDArray float_complex_array_value (bool=false) const
 
virtual FloatComplexDiagMatrix float_complex_diag_matrix_value (bool=false) const
 
virtual FloatComplexMatrix float_complex_matrix_value (bool=false) const
 
virtual FloatComplex float_complex_value (bool=false) const
 
virtual FloatDiagMatrix float_diag_matrix_value (bool=false) const
 
virtual FloatMatrix float_matrix_value (bool=false) const
 
virtual float float_scalar_value (bool frc_str_conv=false) const
 
virtual float float_value (bool=false) const
 
virtual octave_function * function_value (bool silent=false)
 
virtual octave_function * get_cached_fcn (const octave_value_list &)
 
virtual octave_function * get_cached_fcn (void *, void *)
 
virtual bool has_function_cache () const
 
virtual octave::idx_vector index_vector (bool require_integers=false) const
 
virtual int16NDArray int16_array_value () const
 
virtual octave_int16 int16_scalar_value () const
 
virtual int32NDArray int32_array_value () const
 
virtual octave_int32 int32_scalar_value () const
 
virtual int64NDArray int64_array_value () const
 
virtual octave_int64 int64_scalar_value () const
 
virtual int64_t int64_value (bool=false, bool=false) const
 
virtual int8NDArray int8_array_value () const
 
virtual octave_int8 int8_scalar_value () const
 
virtual int int_value (bool=false, bool=false) const
 
virtual bool is_all_va_args () const
 
virtual bool is_anonymous_function () const
 
virtual bool is_bool_matrix () const
 
virtual bool is_bool_scalar () const
 
virtual bool is_builtin_function () const
 
virtual bool is_char_matrix () const
 
virtual bool is_classdef_meta () const
 
virtual bool is_classdef_object () const
 
virtual bool is_classdef_superclass_ref () const
 
virtual bool is_complex_matrix () const
 
virtual bool is_complex_scalar () const
 
virtual bool is_cs_list () const
 
virtual bool is_diag_matrix () const
 
virtual bool is_dld_function () const
 
virtual bool is_double_type () const
 
virtual bool is_function () const
 
virtual bool is_function_cache () const
 
virtual bool is_function_handle () const
 
virtual bool is_inline_function () const
 
virtual bool is_instance_of (const std::string &) const
 
virtual bool is_int16_type () const
 
virtual bool is_int32_type () const
 
virtual bool is_int64_type () const
 
virtual bool is_int8_type () const
 
virtual bool is_legacy_object () const
 
virtual bool is_magic_colon () const
 
virtual bool is_magic_int () const
 
virtual bool is_maybe_function () const
 
virtual bool is_mex_function () const
 
virtual bool is_package () const
 
virtual bool is_perm_matrix () const
 
virtual bool is_range () const
 
virtual bool is_real_matrix () const
 
virtual bool is_real_scalar () const
 
virtual bool is_scalar_type () const
 
virtual bool is_single_type () const
 
virtual bool is_sq_string () const
 
virtual bool is_storable () const
 
virtual bool is_string () const
 
virtual bool is_uint16_type () const
 
virtual bool is_uint32_type () const
 
virtual bool is_uint64_type () const
 
virtual bool is_uint8_type () const
 
virtual bool is_user_code () const
 
virtual bool is_user_function () const
 
virtual bool is_user_script () const
 
bool is_zero_by_zero () const
 
virtual bool iscell () const
 
virtual bool iscellstr () const
 
virtual bool iscomplex () const
 
bool isempty () const
 
virtual bool isfield (const std::string &) const
 
virtual bool isfloat () const
 
virtual bool isinteger () const
 
virtual bool isjava () const
 
virtual bool islocked () const
 
virtual bool islogical () const
 
virtual bool isnull () const
 
virtual bool isobject () const
 
virtual bool issparse () const
 
virtual bool isstruct () const
 
virtual octave_value_list list_value () const
 
virtual bool load_hdf5 (octave_hdf5_id loc_id, const char *name)
 
virtual void lock ()
 
virtual long int long_value (bool=false, bool=false) const
 
virtual octave_base_value * make_storable_value ()
 
virtual octave_value map (unary_mapper_t) const
 
virtual string_vector map_keys () const
 
virtual octave_map map_value () const
 
virtual Matrix matrix_value (bool=false) const
 
virtual void maybe_call_dtor ()
 
virtual const octave_idx_type * mex_get_ir () const
 
virtual const octave_idx_type * mex_get_jc () const
 
virtual octave_idx_type nfields () const
 
virtual int nint_value (bool=false) const
 
virtual std::size_t nparents () const
 
virtual type_conv_info numeric_conversion_function () const
 
virtual type_conv_info numeric_demotion_function () const
 
virtual octave_idx_type nzmax () const
 
virtual std::list< std::string > parent_class_name_list () const
 
virtual string_vector parent_class_names () const
 
virtual PermMatrix perm_matrix_value () const
 
virtual bool print_name_tag (std::ostream &os, const std::string &name) const
 
virtual void print_with_name (std::ostream &output_buf, const std::string &name, bool print_padding=true)
 
virtual octave::range< double > range_value () const
 
octave_idx_type rows () const
 
virtual bool save_hdf5 (octave_hdf5_id loc_id, const char *name, bool save_as_floats)
 
virtual octave_scalar_map scalar_map_value () const
 
virtual double scalar_value (bool frc_str_conv=false) const
 
virtual short int short_value (bool=false, bool=false) const
 
virtual octave_value simple_subsasgn (char type, octave_value_list &idx, const octave_value &rhs)
 
virtual Matrix size ()
 
virtual SparseBoolMatrix sparse_bool_matrix_value (bool=false) const
 
virtual SparseComplexMatrix sparse_complex_matrix_value (bool=false) const
 
virtual SparseMatrix sparse_matrix_value (bool=false) const
 
virtual octave_value storable_value ()
 
virtual std::string string_value (bool force=false) const
 
virtual string_vector string_vector_value (bool pad=false) const
 
virtual octave_value subsref (const std::string &type, const std::list< octave_value_list > &idx, bool auto_add)
 
virtual int type_id () const
 
virtual std::string type_name () const
 
virtual uint16NDArray uint16_array_value () const
 
virtual octave_uint16 uint16_scalar_value () const
 
virtual uint32NDArray uint32_array_value () const
 
virtual octave_uint32 uint32_scalar_value () const
 
virtual uint64NDArray uint64_array_value () const
 
virtual octave_uint64 uint64_scalar_value () const
 
virtual uint64_t uint64_value (bool=false, bool=false) const
 
virtual uint8NDArray uint8_array_value () const
 
virtual octave_uint8 uint8_scalar_value () const
 
virtual unsigned int uint_value (bool=false, bool=false) const
 
virtual unsigned long int ulong_value (bool=false, bool=false) const
 
virtual octave_value undef_subsasgn (const std::string &type, const std::list< octave_value_list > &idx, const octave_value &rhs)
 
virtual octave_base_value * unique_clone ()
 
virtual octave_base_value * unique_parent_class (const std::string &)
 
virtual void unlock ()
 
virtual octave_user_code * user_code_value (bool silent=false)
 
virtual octave_user_function * user_function_value (bool silent=false)
 
virtual octave_user_script * user_script_value (bool silent=false)
 
virtual unsigned short int ushort_value (bool=false, bool=false) const
 
virtual int write (octave::stream &os, int block_size, oct_data_conv::data_type output_type, int skip, octave::mach_info::float_format flt_fmt) const
 
virtual octave_idx_type xnumel (const octave_value_list &)
 
virtual std::string xstring_value () const
 

Protected Member Functions

bool load_hdf5_internal (octave_hdf5_id loc_id, octave_hdf5_id save_type, const char *name)
 
bool save_hdf5_internal (octave_hdf5_id loc_id, octave_hdf5_id save_type, const char *name, bool)
 
- Protected Member Functions inherited from octave_base_matrix< T >
void clear_cached_info () const
 
octave::idx_vector set_idx_cache (const octave::idx_vector &idx) const
 
- Protected Member Functions inherited from octave_base_value
int current_print_indent_level () const
 
void decrement_indent_level () const
 
void increment_indent_level () const
 
void indent (std::ostream &os) const
 
void newline (std::ostream &os) const
 
octave_value numeric_assign (const std::string &type, const std::list< octave_value_list > &idx, const octave_value &rhs)
 
void reset () const
 
void reset_indent_level () const
 
void warn_load (const char *type) const
 
void warn_save (const char *type) const
 

Additional Inherited Members

- Public Types inherited from octave_base_matrix< T >
typedef T object_type
 
- Public Types inherited from octave_base_value
typedef octave_base_value *(* type_conv_fcn) (const octave_base_value &)
 
enum  unary_mapper_t {
  umap_abs , umap_acos , umap_acosh , umap_angle ,
  umap_arg , umap_asin , umap_asinh , umap_atan ,
  umap_atanh , umap_cbrt , umap_ceil , umap_conj ,
  umap_cos , umap_cosh , umap_erf , umap_erfinv ,
  umap_erfcinv , umap_erfc , umap_erfcx , umap_erfi ,
  umap_dawson , umap_exp , umap_expm1 , umap_isfinite ,
  umap_fix , umap_floor , umap_gamma , umap_imag ,
  umap_isinf , umap_isna , umap_isnan , umap_lgamma ,
  umap_log , umap_log2 , umap_log10 , umap_log1p ,
  umap_real , umap_round , umap_roundb , umap_signum ,
  umap_sin , umap_sinh , umap_sqrt , umap_tan ,
  umap_tanh , umap_xisalnum , umap_xisalpha , umap_xisascii ,
  umap_xiscntrl , umap_xisdigit , umap_xisgraph , umap_xislower ,
  umap_xisprint , umap_xispunct , umap_xisspace , umap_xisupper ,
  umap_xisxdigit , umap_xsignbit , umap_xtolower , umap_xtoupper ,
  umap_unknown , num_unary_mappers = umap_unknown
}
 
- Static Public Member Functions inherited from octave_base_value
static void register_type ()
 
static void register_type (octave::type_info &)
 
static std::string static_class_name ()
 
static int static_type_id ()
 
static std::string static_type_name ()
 
- Static Protected Member Functions inherited from octave_base_value
static const char * get_umap_name (unary_mapper_t)
 
- Protected Attributes inherited from octave_base_matrix< T >
octave::idx_vector * m_idx_cache
 
T m_matrix
 
MatrixType * m_typ
 
- Protected Attributes inherited from octave_base_value
octave::refcount< octave_idx_type > & count
 
octave::refcount< octave_idx_type > m_count
 

Detailed Description

template<typename T>
class octave_base_int_matrix< T >

Definition at line 48 of file ov-base-int.h.

Constructor & Destructor Documentation

◆ octave_base_int_matrix() [1/2]

template<typename T >
octave_base_int_matrix< T >::octave_base_int_matrix ( )
inline

Definition at line 54 of file ov-base-int.h.

◆ octave_base_int_matrix() [2/2]

template<typename T >
octave_base_int_matrix< T >::octave_base_int_matrix ( const T &  nda)
inline

Definition at line 56 of file ov-base-int.h.

◆ ~octave_base_int_matrix()

template<typename T >
octave_base_int_matrix< T >::~octave_base_int_matrix ( )
default

Member Function Documentation

◆ as_double()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_double
virtual

Reimplemented from octave_base_value.

Definition at line 208 of file ov-base-int.cc.

◆ as_int16()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_int16
virtual

Reimplemented from octave_base_value.

Definition at line 229 of file ov-base-int.cc.

◆ as_int32()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_int32
virtual

Reimplemented from octave_base_value.

Definition at line 236 of file ov-base-int.cc.

◆ as_int64()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_int64
virtual

Reimplemented from octave_base_value.

Definition at line 243 of file ov-base-int.cc.

◆ as_int8()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_int8
virtual

Reimplemented from octave_base_value.

Definition at line 222 of file ov-base-int.cc.

◆ as_single()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_single
virtual

Reimplemented from octave_base_value.

Definition at line 215 of file ov-base-int.cc.

◆ as_uint16()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_uint16
virtual

Reimplemented from octave_base_value.

Definition at line 257 of file ov-base-int.cc.

◆ as_uint32()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_uint32
virtual

Reimplemented from octave_base_value.

Definition at line 264 of file ov-base-int.cc.

◆ as_uint64()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_uint64
virtual

Reimplemented from octave_base_value.

Definition at line 271 of file ov-base-int.cc.

◆ as_uint8()

template<typename MT >
octave_value octave_base_int_matrix< MT >::as_uint8
virtual

Reimplemented from octave_base_value.

Definition at line 250 of file ov-base-int.cc.

◆ clone()

template<typename T >
octave_base_value* octave_base_int_matrix< T >::clone ( ) const
inlinevirtual

Reimplemented from octave_base_value.

Definition at line 60 of file ov-base-int.h.

◆ convert_to_str_internal()

template<typename T >
octave_value octave_base_int_matrix< T >::convert_to_str_internal ( bool  ,
bool  ,
char  type 
) const
virtual

Reimplemented from octave_base_value.

Definition at line 160 of file ov-base-int.cc.

◆ edit_display()

template<typename T >
std::string octave_base_int_matrix< T >::edit_display ( const float_display_format &  fmt,
octave_idx_type  i,
octave_idx_type  j 
) const
virtual

Reimplemented from octave_base_value.

Definition at line 278 of file ov-base-int.cc.

References octave_print_internal().

◆ empty_clone()

template<typename T >
octave_base_value* octave_base_int_matrix< T >::empty_clone ( ) const
inlinevirtual

Reimplemented from octave_base_value.

Definition at line 63 of file ov-base-int.h.

◆ isreal()

template<typename T >
bool octave_base_int_matrix< T >::isreal ( void  ) const
inlinevirtual

Reimplemented from octave_base_value.

Definition at line 68 of file ov-base-int.h.

◆ load_ascii()

template<typename T >
bool octave_base_int_matrix< T >::load_ascii ( std::istream &  is)
virtual

Reimplemented from octave_base_value.

Definition at line 305 of file ov-base-int.cc.

References error(), extract_keyword(), and dim_vector::resize().

◆ load_binary()

template<typename T >
bool octave_base_int_matrix< T >::load_binary ( std::istream &  is,
bool  swap,
octave::mach_info::float_format   
)
virtual

Reimplemented from octave_base_value.

Definition at line 358 of file ov-base-int.cc.

References m, dim_vector::numel(), dim_vector::resize(), swap_bytes< 2 >(), swap_bytes< 4 >(), and swap_bytes< 8 >().

◆ load_hdf5_internal()

template<typename T >
bool octave_base_int_matrix< T >::load_hdf5_internal ( octave_hdf5_id  loc_id,
octave_hdf5_id  save_type,
const char *  name 
)
protected

Definition at line 487 of file ov-base-int.cc.

References load_hdf5_empty(), m, octave_H5P_DEFAULT, octave_H5S_ALL, OCTAVE_LOCAL_BUFFER, and dim_vector::resize().

◆ print_raw()

template<typename T >
void octave_base_int_matrix< T >::print_raw ( std::ostream &  os,
bool  pr_as_read_syntax = false 
) const
virtual

Reimplemented from octave_base_value.

Definition at line 562 of file ov-base-int.cc.

References octave_print_internal().

◆ save_ascii()

template<typename T >
bool octave_base_int_matrix< T >::save_ascii ( std::ostream &  os)
virtual

Reimplemented from octave_base_value.

Definition at line 289 of file ov-base-int.cc.

References dim_vector::ndims().

◆ save_binary()

template<typename T >
bool octave_base_int_matrix< T >::save_binary ( std::ostream &  os,
bool   
)
virtual

Reimplemented from octave_base_value.

Definition at line 335 of file ov-base-int.cc.

References dim_vector::ndims().

◆ save_hdf5_internal()

template<typename T >
bool octave_base_int_matrix< T >::save_hdf5_internal ( octave_hdf5_id  loc_id,
octave_hdf5_id  save_type,
const char *  name,
bool   
)
protected

Definition at line 428 of file ov-base-int.cc.

References dim_vector::ndims(), octave_H5P_DEFAULT, octave_H5S_ALL, OCTAVE_LOCAL_BUFFER, and save_hdf5_empty().

◆ try_narrowing_conversion()

template<typename T >
octave_base_value * octave_base_int_matrix< T >::try_narrowing_conversion
virtual

Reimplemented from octave_base_value.

Definition at line 147 of file ov-base-int.cc.

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