291 lines
11 KiB
C++
291 lines
11 KiB
C++
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
// 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.
|
|
// ------------------------------------------------------------------------
|
|
|
|
|
|
//! \addtogroup Row
|
|
//! @{
|
|
|
|
//! Class for row vectors (matrices with only one row)
|
|
|
|
template<typename eT>
|
|
class Row : public Mat<eT>
|
|
{
|
|
public:
|
|
|
|
typedef eT elem_type;
|
|
typedef typename get_pod_type<eT>::result pod_type;
|
|
|
|
static constexpr bool is_col = false;
|
|
static constexpr bool is_row = true;
|
|
static constexpr bool is_xvec = false;
|
|
|
|
inline Row();
|
|
inline Row(const Row<eT>& X);
|
|
|
|
inline explicit Row(const uword N);
|
|
inline explicit Row(const uword in_rows, const uword in_cols);
|
|
inline explicit Row(const SizeMat& s);
|
|
|
|
template<bool do_zeros> inline explicit Row(const uword N, const arma_initmode_indicator<do_zeros>&);
|
|
template<bool do_zeros> inline explicit Row(const uword in_rows, const uword in_cols, const arma_initmode_indicator<do_zeros>&);
|
|
template<bool do_zeros> inline explicit Row(const SizeMat& s, const arma_initmode_indicator<do_zeros>&);
|
|
|
|
template<typename fill_type> inline Row(const uword n_elem, const fill::fill_class<fill_type>& f);
|
|
template<typename fill_type> inline Row(const uword in_rows, const uword in_cols, const fill::fill_class<fill_type>& f);
|
|
template<typename fill_type> inline Row(const SizeMat& s, const fill::fill_class<fill_type>& f);
|
|
|
|
inline Row(const uword N, const fill::scalar_holder<eT> f);
|
|
inline Row(const uword in_rows, const uword in_cols, const fill::scalar_holder<eT> f);
|
|
inline Row(const SizeMat& s, const fill::scalar_holder<eT> f);
|
|
|
|
inline Row(const char* text);
|
|
inline Row& operator=(const char* text);
|
|
|
|
inline Row(const std::string& text);
|
|
inline Row& operator=(const std::string& text);
|
|
|
|
inline Row(const std::vector<eT>& x);
|
|
inline Row& operator=(const std::vector<eT>& x);
|
|
|
|
inline Row(const std::initializer_list<eT>& list);
|
|
inline Row& operator=(const std::initializer_list<eT>& list);
|
|
|
|
inline Row(Row&& m);
|
|
inline Row& operator=(Row&& m);
|
|
|
|
// inline Row(Mat<eT>&& m);
|
|
// inline Row& operator=(Mat<eT>&& m);
|
|
|
|
inline Row& operator=(const eT val);
|
|
inline Row& operator=(const Row& X);
|
|
|
|
template<typename T1> inline Row(const Base<eT,T1>& X);
|
|
template<typename T1> inline Row& operator=(const Base<eT,T1>& X);
|
|
|
|
template<typename T1> inline explicit Row(const SpBase<eT,T1>& X);
|
|
template<typename T1> inline Row& operator=(const SpBase<eT,T1>& X);
|
|
|
|
inline Row( eT* aux_mem, const uword aux_length, const bool copy_aux_mem = true, const bool strict = false);
|
|
inline Row(const eT* aux_mem, const uword aux_length);
|
|
|
|
template<typename T1, typename T2>
|
|
inline explicit Row(const Base<pod_type,T1>& A, const Base<pod_type,T2>& B);
|
|
|
|
template<typename T1> inline Row(const BaseCube<eT,T1>& X);
|
|
template<typename T1> inline Row& operator=(const BaseCube<eT,T1>& X);
|
|
|
|
inline Row(const subview_cube<eT>& X);
|
|
inline Row& operator=(const subview_cube<eT>& X);
|
|
|
|
arma_frown("use braced initialiser list instead") inline mat_injector<Row> operator<<(const eT val);
|
|
|
|
arma_warn_unused arma_inline const Op<Row<eT>,op_htrans> t() const;
|
|
arma_warn_unused arma_inline const Op<Row<eT>,op_htrans> ht() const;
|
|
arma_warn_unused arma_inline const Op<Row<eT>,op_strans> st() const;
|
|
|
|
arma_warn_unused arma_inline const Op<Row<eT>,op_strans> as_col() const;
|
|
|
|
arma_inline subview_row<eT> col(const uword col_num);
|
|
arma_inline const subview_row<eT> col(const uword col_num) const;
|
|
|
|
using Mat<eT>::cols;
|
|
using Mat<eT>::operator();
|
|
|
|
arma_inline subview_row<eT> cols(const uword in_col1, const uword in_col2);
|
|
arma_inline const subview_row<eT> cols(const uword in_col1, const uword in_col2) const;
|
|
|
|
arma_inline subview_row<eT> subvec(const uword in_col1, const uword in_col2);
|
|
arma_inline const subview_row<eT> subvec(const uword in_col1, const uword in_col2) const;
|
|
|
|
arma_inline subview_row<eT> cols(const span& col_span);
|
|
arma_inline const subview_row<eT> cols(const span& col_span) const;
|
|
|
|
arma_inline subview_row<eT> subvec(const span& col_span);
|
|
arma_inline const subview_row<eT> subvec(const span& col_span) const;
|
|
|
|
arma_inline subview_row<eT> operator()(const span& col_span);
|
|
arma_inline const subview_row<eT> operator()(const span& col_span) const;
|
|
|
|
arma_inline subview_row<eT> subvec(const uword start_col, const SizeMat& s);
|
|
arma_inline const subview_row<eT> subvec(const uword start_col, const SizeMat& s) const;
|
|
|
|
arma_inline subview_row<eT> head(const uword N);
|
|
arma_inline const subview_row<eT> head(const uword N) const;
|
|
|
|
arma_inline subview_row<eT> tail(const uword N);
|
|
arma_inline const subview_row<eT> tail(const uword N) const;
|
|
|
|
arma_inline subview_row<eT> head_cols(const uword N);
|
|
arma_inline const subview_row<eT> head_cols(const uword N) const;
|
|
|
|
arma_inline subview_row<eT> tail_cols(const uword N);
|
|
arma_inline const subview_row<eT> tail_cols(const uword N) const;
|
|
|
|
|
|
inline void shed_col (const uword col_num);
|
|
inline void shed_cols(const uword in_col1, const uword in_col2);
|
|
|
|
template<typename T1> inline void shed_cols(const Base<uword, T1>& indices);
|
|
|
|
arma_deprecated inline void insert_cols(const uword col_num, const uword N, const bool set_to_zero);
|
|
inline void insert_cols(const uword col_num, const uword N);
|
|
|
|
template<typename T1> inline void insert_cols(const uword col_num, const Base<eT,T1>& X);
|
|
|
|
|
|
arma_warn_unused arma_inline eT& at(const uword i);
|
|
arma_warn_unused arma_inline const eT& at(const uword i) const;
|
|
|
|
arma_warn_unused arma_inline eT& at(const uword in_row, const uword in_col);
|
|
arma_warn_unused arma_inline const eT& at(const uword in_row, const uword in_col) const;
|
|
|
|
|
|
typedef eT* row_iterator;
|
|
typedef const eT* const_row_iterator;
|
|
|
|
inline row_iterator begin_row(const uword row_num);
|
|
inline const_row_iterator begin_row(const uword row_num) const;
|
|
|
|
inline row_iterator end_row (const uword row_num);
|
|
inline const_row_iterator end_row (const uword row_num) const;
|
|
|
|
|
|
template<uword fixed_n_elem> class fixed;
|
|
|
|
|
|
protected:
|
|
|
|
inline Row(const arma_fixed_indicator&, const uword in_n_elem, const eT* in_mem);
|
|
|
|
|
|
public:
|
|
|
|
#if defined(ARMA_EXTRA_ROW_PROTO)
|
|
#include ARMA_INCFILE_WRAP(ARMA_EXTRA_ROW_PROTO)
|
|
#endif
|
|
};
|
|
|
|
|
|
|
|
template<typename eT>
|
|
template<uword fixed_n_elem>
|
|
class Row<eT>::fixed : public Row<eT>
|
|
{
|
|
private:
|
|
|
|
using Mat<eT>::mem_local;
|
|
|
|
static constexpr bool use_extra = (fixed_n_elem > arma_config::mat_prealloc);
|
|
|
|
arma_align_mem eT mem_local_extra[ (use_extra) ? fixed_n_elem : 1 ];
|
|
|
|
|
|
public:
|
|
|
|
typedef fixed<fixed_n_elem> Row_fixed_type;
|
|
|
|
typedef eT elem_type;
|
|
typedef typename get_pod_type<eT>::result pod_type;
|
|
|
|
static constexpr bool is_col = false;
|
|
static constexpr bool is_row = true;
|
|
static constexpr bool is_xvec = false;
|
|
|
|
static const uword n_rows; // value provided below the class definition
|
|
static const uword n_cols; // value provided below the class definition
|
|
static const uword n_elem; // value provided below the class definition
|
|
|
|
arma_inline fixed();
|
|
arma_inline fixed(const fixed<fixed_n_elem>& X);
|
|
inline fixed(const subview_cube<eT>& X);
|
|
|
|
inline fixed(const fill::scalar_holder<eT> f);
|
|
template<typename fill_type> inline fixed(const fill::fill_class<fill_type>& f);
|
|
template<typename T1> inline fixed(const Base<eT,T1>& A);
|
|
template<typename T1, typename T2> inline fixed(const Base<pod_type,T1>& A, const Base<pod_type,T2>& B);
|
|
|
|
inline fixed(const eT* aux_mem);
|
|
|
|
inline fixed(const char* text);
|
|
inline fixed(const std::string& text);
|
|
|
|
template<typename T1> inline Row& operator=(const Base<eT,T1>& A);
|
|
|
|
inline Row& operator=(const eT val);
|
|
inline Row& operator=(const char* text);
|
|
inline Row& operator=(const std::string& text);
|
|
inline Row& operator=(const subview_cube<eT>& X);
|
|
|
|
using Row<eT>::operator();
|
|
|
|
inline fixed(const std::initializer_list<eT>& list);
|
|
inline Row& operator=(const std::initializer_list<eT>& list);
|
|
|
|
arma_inline Row& operator=(const fixed<fixed_n_elem>& X);
|
|
|
|
#if defined(ARMA_GOOD_COMPILER)
|
|
template<typename T1, typename eop_type> inline Row& operator=(const eOp<T1, eop_type>& X);
|
|
template<typename T1, typename T2, typename eglue_type> inline Row& operator=(const eGlue<T1, T2, eglue_type>& X);
|
|
#endif
|
|
|
|
arma_warn_unused arma_inline const Op< Row_fixed_type, op_htrans > t() const;
|
|
arma_warn_unused arma_inline const Op< Row_fixed_type, op_htrans > ht() const;
|
|
arma_warn_unused arma_inline const Op< Row_fixed_type, op_strans > st() const;
|
|
|
|
arma_warn_unused arma_inline const eT& at_alt (const uword i) const;
|
|
|
|
arma_warn_unused arma_inline eT& operator[] (const uword i);
|
|
arma_warn_unused arma_inline const eT& operator[] (const uword i) const;
|
|
arma_warn_unused arma_inline eT& at (const uword i);
|
|
arma_warn_unused arma_inline const eT& at (const uword i) const;
|
|
arma_warn_unused arma_inline eT& operator() (const uword i);
|
|
arma_warn_unused arma_inline const eT& operator() (const uword i) const;
|
|
|
|
arma_warn_unused arma_inline eT& at (const uword in_row, const uword in_col);
|
|
arma_warn_unused arma_inline const eT& at (const uword in_row, const uword in_col) const;
|
|
arma_warn_unused arma_inline eT& operator() (const uword in_row, const uword in_col);
|
|
arma_warn_unused arma_inline const eT& operator() (const uword in_row, const uword in_col) const;
|
|
|
|
arma_warn_unused arma_inline eT* memptr();
|
|
arma_warn_unused arma_inline const eT* memptr() const;
|
|
|
|
inline const Row<eT>& fill(const eT val);
|
|
inline const Row<eT>& zeros();
|
|
inline const Row<eT>& ones();
|
|
};
|
|
|
|
|
|
|
|
// these definitions are outside of the class due to bizarre C++ rules;
|
|
// C++17 has inline variables to address this shortcoming
|
|
|
|
template<typename eT>
|
|
template<uword fixed_n_elem>
|
|
const uword Row<eT>::fixed<fixed_n_elem>::n_rows = 1u;
|
|
|
|
template<typename eT>
|
|
template<uword fixed_n_elem>
|
|
const uword Row<eT>::fixed<fixed_n_elem>::n_cols = fixed_n_elem;
|
|
|
|
template<typename eT>
|
|
template<uword fixed_n_elem>
|
|
const uword Row<eT>::fixed<fixed_n_elem>::n_elem = fixed_n_elem;
|
|
|
|
|
|
|
|
//! @}
|