1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
|
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1998-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING. If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////
#if ! defined (octave_ov_base_sparse_h)
#define octave_ov_base_sparse_h 1
#include "octave-config.h"
#include <cstdlib>
#include <iosfwd>
#include <string>
#include "str-vec.h"
#include "error.h"
#include "ovl.h"
#include "ov-base.h"
#include "ov-typeinfo.h"
#include "boolSparse.h"
#include "MatrixType.h"
class octave_sparse_bool_matrix;
template <typename T>
class
octave_base_sparse : public octave_base_value
{
public:
octave_base_sparse (void)
: octave_base_value (), matrix (), typ (MatrixType ())
{ }
octave_base_sparse (const T& a)
: octave_base_value (), matrix (a), typ (MatrixType ())
{
if (matrix.ndims () == 0)
matrix.resize (dim_vector (0, 0));
}
octave_base_sparse (const T& a, const MatrixType& t)
: octave_base_value (), matrix (a), typ (t)
{
if (matrix.ndims () == 0)
matrix.resize (dim_vector (0, 0));
}
octave_base_sparse (const octave_base_sparse& a)
: octave_base_value (), matrix (a.matrix), typ (a.typ) { }
~octave_base_sparse (void) = default;
octave_idx_type numel (void) const { return dims ().safe_numel (); }
octave_idx_type nnz (void) const { return matrix.nnz (); }
octave_idx_type nzmax (void) const { return matrix.nzmax (); }
size_t byte_size (void) const { return matrix.byte_size (); }
octave_value squeeze (void) const { return matrix.squeeze (); }
octave_value full_value (void) const { return matrix.matrix_value (); }
// We don't need to override all three forms of subsref. The using
// declaration will avoid warnings about partially-overloaded virtual
// functions.
using octave_base_value::subsref;
octave_value subsref (const std::string& type,
const std::list<octave_value_list>& idx);
octave_value_list subsref (const std::string& type,
const std::list<octave_value_list>& idx, int)
{ return subsref (type, idx); }
octave_value subsasgn (const std::string& type,
const std::list<octave_value_list>& idx,
const octave_value& rhs);
// FIXME: should we import the functions from the base class and
// overload them here, or should we use a different name so we don't
// have to do this? Without the using declaration or a name change,
// the base class functions will be hidden. That may be OK, but it
// can also cause some confusion.
using octave_base_value::assign;
void assign (const octave_value_list& idx, const T& rhs);
void delete_elements (const octave_value_list& idx);
dim_vector dims (void) const { return matrix.dims (); }
octave_value do_index_op (const octave_value_list& idx,
bool resize_ok = false);
octave_value reshape (const dim_vector& new_dims) const
{ return T (matrix.reshape (new_dims)); }
octave_value permute (const Array<int>& vec, bool inv = false) const
{ return T (matrix.permute (vec, inv)); }
octave_value resize (const dim_vector& dv, bool = false) const;
octave_value all (int dim = 0) const { return matrix.all (dim); }
octave_value any (int dim = 0) const { return matrix.any (dim); }
// We don't need to override both forms of the diag method. The using
// declaration will avoid warnings about partially-overloaded virtual
// functions.
using octave_base_value::diag;
octave_value diag (octave_idx_type k = 0) const
{ return octave_value (matrix.diag (k)); }
octave_value sort (octave_idx_type dim = 0, sortmode mode = ASCENDING) const
{ return octave_value (matrix.sort (dim, mode)); }
octave_value sort (Array<octave_idx_type> &sidx, octave_idx_type dim = 0,
sortmode mode = ASCENDING) const
{ return octave_value (matrix.sort (sidx, dim, mode)); }
sortmode issorted (sortmode mode = UNSORTED) const
{ return full_value ().issorted (mode); }
MatrixType matrix_type (void) const { return typ; }
MatrixType matrix_type (const MatrixType& _typ) const
{ MatrixType ret = typ; typ = _typ; return ret; }
bool is_matrix_type (void) const { return true; }
bool isnumeric (void) const { return true; }
bool issparse (void) const { return true; }
bool is_defined (void) const { return true; }
bool is_constant (void) const { return true; }
bool is_true (void) const;
bool print_as_scalar (void) const;
void print (std::ostream& os, bool pr_as_read_syntax = false);
void print_info (std::ostream& os, const std::string& prefix) const;
void print_raw (std::ostream& os, bool pr_as_read_syntax = false) const;
bool save_ascii (std::ostream& os);
bool load_ascii (std::istream& is);
float_display_format get_edit_display_format (void) const;
std::string edit_display (const float_display_format& fmt,
octave_idx_type i, octave_idx_type j) const;
// Unsafe. These functions exists to support the MEX interface.
// You should not use them anywhere else.
void * mex_get_data (void) const { return matrix.mex_get_data (); }
octave_idx_type * mex_get_ir (void) const { return matrix.mex_get_ir (); }
octave_idx_type * mex_get_jc (void) const { return matrix.mex_get_jc (); }
octave_value fast_elem_extract (octave_idx_type n) const;
protected:
octave_value map (octave_base_value::unary_mapper_t umap) const;
T matrix;
mutable MatrixType typ;
};
#endif
|