467 lines
12 KiB
C++
467 lines
12 KiB
C++
// Copyright 2008-2016 Conrad Sanderson (http://conradsanderson.id.au)
|
|
// Copyright 2008-2016 National ICT Australia (NICTA)
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
// ------------------------------------------------------------------------
|
|
|
|
|
|
using std::cout;
|
|
using std::cerr;
|
|
using std::endl;
|
|
using std::ios;
|
|
using std::size_t;
|
|
|
|
template<typename elem_type, typename derived> struct Base;
|
|
template<typename elem_type, typename derived> struct BaseCube;
|
|
|
|
template<typename eT> class Mat;
|
|
template<typename eT> class Col;
|
|
template<typename eT> class Row;
|
|
template<typename eT> class Cube;
|
|
template<typename eT> class xvec_htrans;
|
|
template<typename oT> class field;
|
|
|
|
template<typename eT, bool do_conj> class xtrans_mat;
|
|
|
|
|
|
template<typename eT> class subview;
|
|
template<typename eT> class subview_col;
|
|
template<typename eT> class subview_row;
|
|
template<typename eT> class subview_row_strans;
|
|
template<typename eT> class subview_row_htrans;
|
|
template<typename eT> class subview_cube;
|
|
template<typename oT> class subview_field;
|
|
|
|
template<typename eT> class SpValProxy;
|
|
template<typename eT> class SpMat;
|
|
template<typename eT> class SpCol;
|
|
template<typename eT> class SpRow;
|
|
template<typename eT> class SpSubview;
|
|
template<typename eT> class SpSubview_col;
|
|
template<typename eT> class SpSubview_row;
|
|
|
|
template<typename eT> class diagview;
|
|
template<typename eT> class spdiagview;
|
|
|
|
template<typename eT> class MapMat;
|
|
template<typename eT> class MapMat_val;
|
|
template<typename eT> class SpMat_MapMat_val;
|
|
template<typename eT> class SpSubview_MapMat_val;
|
|
|
|
template<typename eT, typename T1> class subview_elem1;
|
|
template<typename eT, typename T1, typename T2> class subview_elem2;
|
|
|
|
template<typename parent, unsigned int mode> class subview_each1;
|
|
template<typename parent, unsigned int mode, typename TB> class subview_each2;
|
|
|
|
template<typename eT> class subview_cube_each1;
|
|
template<typename eT, typename TB> class subview_cube_each2;
|
|
template<typename eT, typename T1> class subview_cube_slices;
|
|
|
|
template<typename eT, typename T1> class SpSubview_col_list;
|
|
|
|
|
|
class SizeMat;
|
|
class SizeCube;
|
|
|
|
class arma_empty_class {};
|
|
|
|
class diskio;
|
|
|
|
class op_strans;
|
|
class op_htrans;
|
|
class op_htrans2;
|
|
class op_inv;
|
|
class op_inv_sympd;
|
|
class op_diagmat;
|
|
class op_trimat;
|
|
class op_vectorise_row;
|
|
class op_vectorise_col;
|
|
class glue_times;
|
|
class glue_times_diag;
|
|
|
|
class glue_rel_lt;
|
|
class glue_rel_gt;
|
|
class glue_rel_lteq;
|
|
class glue_rel_gteq;
|
|
class glue_rel_eq;
|
|
class glue_rel_noteq;
|
|
class glue_rel_and;
|
|
class glue_rel_or;
|
|
|
|
class op_rel_lt_pre;
|
|
class op_rel_lt_post;
|
|
class op_rel_gt_pre;
|
|
class op_rel_gt_post;
|
|
class op_rel_lteq_pre;
|
|
class op_rel_lteq_post;
|
|
class op_rel_gteq_pre;
|
|
class op_rel_gteq_post;
|
|
class op_rel_eq;
|
|
class op_rel_noteq;
|
|
|
|
class gen_eye;
|
|
class gen_ones;
|
|
class gen_zeros;
|
|
class gen_randu;
|
|
class gen_randn;
|
|
|
|
|
|
|
|
class spop_strans;
|
|
class spop_htrans;
|
|
class spop_vectorise_row;
|
|
class spop_vectorise_col;
|
|
|
|
class spglue_plus;
|
|
class spglue_minus;
|
|
class spglue_schur;
|
|
class spglue_times;
|
|
class spglue_max;
|
|
class spglue_min;
|
|
class spglue_rel_lt;
|
|
class spglue_rel_gt;
|
|
|
|
|
|
|
|
class op_internal_equ;
|
|
class op_internal_plus;
|
|
class op_internal_minus;
|
|
class op_internal_schur;
|
|
class op_internal_div;
|
|
|
|
|
|
|
|
struct traits_op_default
|
|
{
|
|
template<typename T1>
|
|
struct traits
|
|
{
|
|
static constexpr bool is_row = false;
|
|
static constexpr bool is_col = false;
|
|
static constexpr bool is_xvec = false;
|
|
};
|
|
};
|
|
|
|
|
|
struct traits_op_xvec
|
|
{
|
|
template<typename T1>
|
|
struct traits
|
|
{
|
|
static constexpr bool is_row = false;
|
|
static constexpr bool is_col = false;
|
|
static constexpr bool is_xvec = true;
|
|
};
|
|
};
|
|
|
|
|
|
struct traits_op_col
|
|
{
|
|
template<typename T1>
|
|
struct traits
|
|
{
|
|
static constexpr bool is_row = false;
|
|
static constexpr bool is_col = true;
|
|
static constexpr bool is_xvec = false;
|
|
};
|
|
};
|
|
|
|
|
|
struct traits_op_row
|
|
{
|
|
template<typename T1>
|
|
struct traits
|
|
{
|
|
static constexpr bool is_row = true;
|
|
static constexpr bool is_col = false;
|
|
static constexpr bool is_xvec = false;
|
|
};
|
|
};
|
|
|
|
|
|
struct traits_op_passthru
|
|
{
|
|
template<typename T1>
|
|
struct traits
|
|
{
|
|
static constexpr bool is_row = T1::is_row;
|
|
static constexpr bool is_col = T1::is_col;
|
|
static constexpr bool is_xvec = T1::is_xvec;
|
|
};
|
|
};
|
|
|
|
|
|
struct traits_glue_default
|
|
{
|
|
template<typename T1, typename T2>
|
|
struct traits
|
|
{
|
|
static constexpr bool is_row = false;
|
|
static constexpr bool is_col = false;
|
|
static constexpr bool is_xvec = false;
|
|
};
|
|
};
|
|
|
|
|
|
struct traits_glue_or
|
|
{
|
|
template<typename T1, typename T2>
|
|
struct traits
|
|
{
|
|
static constexpr bool is_row = (T1::is_row || T2::is_row );
|
|
static constexpr bool is_col = (T1::is_col || T2::is_col );
|
|
static constexpr bool is_xvec = (T1::is_xvec || T2::is_xvec);
|
|
};
|
|
};
|
|
|
|
|
|
|
|
template<const bool, const bool, const bool, const bool> class gemm;
|
|
template<const bool, const bool, const bool> class gemv;
|
|
|
|
|
|
template< typename eT, typename gen_type> class Gen;
|
|
|
|
template< typename T1, typename op_type> class Op;
|
|
template< typename T1, typename eop_type> class eOp;
|
|
template< typename T1, typename op_type> class SpToDOp;
|
|
template< typename T1, typename op_type> class CubeToMatOp;
|
|
template<typename out_eT, typename T1, typename op_type> class mtOp;
|
|
|
|
template< typename T1, typename T2, typename glue_type> class Glue;
|
|
template< typename T1, typename T2, typename eglue_type> class eGlue;
|
|
template<typename out_eT, typename T1, typename T2, typename glue_type> class mtGlue;
|
|
|
|
|
|
|
|
template< typename eT, typename gen_type> class GenCube;
|
|
|
|
template< typename T1, typename op_type> class OpCube;
|
|
template< typename T1, typename eop_type> class eOpCube;
|
|
template<typename out_eT, typename T1, typename op_type> class mtOpCube;
|
|
|
|
template< typename T1, typename T2, typename glue_type> class GlueCube;
|
|
template< typename T1, typename T2, typename eglue_type> class eGlueCube;
|
|
template<typename out_eT, typename T1, typename T2, typename glue_type> class mtGlueCube;
|
|
|
|
|
|
template<typename T1> class Proxy;
|
|
template<typename T1> class ProxyCube;
|
|
|
|
template<typename T1> class diagmat_proxy;
|
|
|
|
template<typename T1> struct unwrap;
|
|
template<typename T1> struct quasi_unwrap;
|
|
template<typename T1> struct unwrap_cube;
|
|
template<typename T1> struct unwrap_spmat;
|
|
|
|
|
|
|
|
|
|
struct state_type
|
|
{
|
|
#if defined(ARMA_USE_OPENMP)
|
|
int state;
|
|
#elif (!defined(ARMA_DONT_USE_STD_MUTEX))
|
|
std::atomic<int> state;
|
|
#else
|
|
int state;
|
|
#endif
|
|
|
|
arma_inline state_type() : state(int(0)) {}
|
|
|
|
// openmp: "omp atomic" does an implicit flush on the affected variable
|
|
// C++11: std::atomic<>::load() and std::atomic<>::store() use std::memory_order_seq_cst by default, which has an implied fence
|
|
|
|
arma_inline
|
|
operator int () const
|
|
{
|
|
int out;
|
|
|
|
#if defined(ARMA_USE_OPENMP)
|
|
#pragma omp atomic read
|
|
out = state;
|
|
#elif (!defined(ARMA_DONT_USE_STD_MUTEX))
|
|
out = state.load();
|
|
#else
|
|
out = state;
|
|
#endif
|
|
|
|
return out;
|
|
}
|
|
|
|
arma_inline
|
|
void
|
|
operator= (const int in_state)
|
|
{
|
|
#if defined(ARMA_USE_OPENMP)
|
|
#pragma omp atomic write
|
|
state = in_state;
|
|
#elif (!defined(ARMA_DONT_USE_STD_MUTEX))
|
|
state.store(in_state);
|
|
#else
|
|
state = in_state;
|
|
#endif
|
|
}
|
|
};
|
|
|
|
|
|
template< typename T1, typename spop_type> class SpOp;
|
|
template<typename out_eT, typename T1, typename spop_type> class mtSpOp;
|
|
|
|
template< typename T1, typename T2, typename spglue_type> class SpGlue;
|
|
template<typename out_eT, typename T1, typename T2, typename spglue_type> class mtSpGlue;
|
|
|
|
|
|
template<typename T1> class SpProxy;
|
|
|
|
|
|
|
|
struct arma_vec_indicator {};
|
|
struct arma_fixed_indicator {};
|
|
struct arma_reserve_indicator {};
|
|
struct arma_layout_indicator {};
|
|
|
|
template<bool do_zeros> struct arma_initmode_indicator {};
|
|
|
|
struct arma_zeros_indicator : public arma_initmode_indicator<true > {};
|
|
struct arma_nozeros_indicator : public arma_initmode_indicator<false> {};
|
|
|
|
|
|
//! \addtogroup injector
|
|
//! @{
|
|
|
|
template<typename Dummy = int> struct injector_end_of_row {};
|
|
|
|
static const injector_end_of_row<> endr = injector_end_of_row<>();
|
|
//!< endr indicates "end of row" when using the << operator;
|
|
//!< similar conceptual meaning to std::endl
|
|
|
|
//! @}
|
|
|
|
|
|
|
|
//! \addtogroup diskio
|
|
//! @{
|
|
|
|
|
|
enum struct file_type : unsigned int
|
|
{
|
|
file_type_unknown,
|
|
auto_detect, //!< attempt to automatically detect the file type
|
|
raw_ascii, //!< raw text (ASCII), without a header
|
|
arma_ascii, //!< Armadillo text format, with a header specifying matrix type and size
|
|
csv_ascii, //!< comma separated values (CSV), without a header
|
|
raw_binary, //!< raw binary format (machine dependent), without a header
|
|
arma_binary, //!< Armadillo binary format (machine dependent), with a header specifying matrix type and size
|
|
pgm_binary, //!< Portable Grey Map (greyscale image)
|
|
ppm_binary, //!< Portable Pixel Map (colour image), used by the field and cube classes
|
|
hdf5_binary, //!< HDF5: open binary format, not specific to Armadillo, which can store arbitrary data
|
|
hdf5_binary_trans, //!< [NOTE: DO NOT USE - deprecated] as per hdf5_binary, but save/load the data with columns transposed to rows
|
|
coord_ascii, //!< simple co-ordinate format for sparse matrices (indices start at zero)
|
|
ssv_ascii, //!< similar to csv_ascii; uses semicolon (;) instead of comma (,) as the separator
|
|
};
|
|
|
|
|
|
static constexpr file_type file_type_unknown = file_type::file_type_unknown;
|
|
static constexpr file_type auto_detect = file_type::auto_detect;
|
|
static constexpr file_type raw_ascii = file_type::raw_ascii;
|
|
static constexpr file_type arma_ascii = file_type::arma_ascii;
|
|
static constexpr file_type csv_ascii = file_type::csv_ascii;
|
|
static constexpr file_type raw_binary = file_type::raw_binary;
|
|
static constexpr file_type arma_binary = file_type::arma_binary;
|
|
static constexpr file_type pgm_binary = file_type::pgm_binary;
|
|
static constexpr file_type ppm_binary = file_type::ppm_binary;
|
|
static constexpr file_type hdf5_binary = file_type::hdf5_binary;
|
|
static constexpr file_type hdf5_binary_trans = file_type::hdf5_binary_trans;
|
|
static constexpr file_type coord_ascii = file_type::coord_ascii;
|
|
static constexpr file_type ssv_ascii = file_type::ssv_ascii;
|
|
|
|
|
|
struct hdf5_name;
|
|
struct csv_name;
|
|
|
|
|
|
//! @}
|
|
|
|
|
|
|
|
//! \addtogroup fn_spsolve
|
|
//! @{
|
|
|
|
|
|
struct spsolve_opts_base
|
|
{
|
|
const unsigned int id;
|
|
|
|
inline spsolve_opts_base(const unsigned int in_id) : id(in_id) {}
|
|
};
|
|
|
|
|
|
struct spsolve_opts_none : public spsolve_opts_base
|
|
{
|
|
inline spsolve_opts_none() : spsolve_opts_base(0) {}
|
|
};
|
|
|
|
|
|
struct superlu_opts : public spsolve_opts_base
|
|
{
|
|
typedef enum {NATURAL, MMD_ATA, MMD_AT_PLUS_A, COLAMD} permutation_type;
|
|
|
|
typedef enum {REF_NONE, REF_SINGLE, REF_DOUBLE, REF_EXTRA} refine_type;
|
|
|
|
bool allow_ugly;
|
|
bool equilibrate;
|
|
bool symmetric;
|
|
double pivot_thresh;
|
|
permutation_type permutation;
|
|
refine_type refine;
|
|
|
|
inline superlu_opts()
|
|
: spsolve_opts_base(1)
|
|
{
|
|
allow_ugly = false;
|
|
equilibrate = false;
|
|
symmetric = false;
|
|
pivot_thresh = 1.0;
|
|
permutation = COLAMD;
|
|
refine = REF_NONE;
|
|
}
|
|
};
|
|
|
|
|
|
//! @}
|
|
|
|
|
|
|
|
//! \ingroup fn_eigs_sym fs_eigs_gen
|
|
//! @{
|
|
|
|
|
|
struct eigs_opts
|
|
{
|
|
double tol; // tolerance
|
|
unsigned int maxiter; // max iterations
|
|
unsigned int subdim; // subspace dimension
|
|
|
|
inline eigs_opts()
|
|
{
|
|
tol = 0.0;
|
|
maxiter = 1000;
|
|
subdim = 0;
|
|
}
|
|
};
|
|
|
|
|
|
//! @}
|