Move into version control

1 files changed, 167 insertions, 0 deletions

diff --git a/src/armadillo/include/armadillo_bits/Base_bones.hpp b/src/armadillo/include/armadillo_bits/Base_bones.hpp
new file mode 100644
index 0000000..ac94785
--- /dev/null
+++ b/src/armadillo/include/armadillo_bits/Base_bones.hpp
@@ -0,0 +1,167 @@
+// 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 Base
+//! @{
+
+
+
+template<typename elem_type, typename derived>
+struct Base_extra_yes
+  {
+  arma_warn_unused inline const Op<derived,op_inv_gen_default> i() const;   //!< matrix inverse
+  
+  arma_warn_unused inline bool is_sympd() const;
+  arma_warn_unused inline bool is_sympd(typename get_pod_type<elem_type>::result tol) const;
+  };
+
+
+template<typename elem_type, typename derived>
+struct Base_extra_no
+  {
+  };
+
+
+template<typename elem_type, typename derived, bool condition>
+struct Base_extra {};
+
+template<typename elem_type, typename derived>
+struct Base_extra<elem_type, derived, true>  { typedef Base_extra_yes<elem_type, derived> result; };
+
+template<typename elem_type, typename derived>
+struct Base_extra<elem_type, derived, false> { typedef Base_extra_no<elem_type, derived>  result; };
+
+
+
+template<typename elem_type, typename derived>
+struct Base_eval_Mat
+  {
+  arma_warn_unused arma_inline const derived& eval() const;
+  };
+
+
+template<typename elem_type, typename derived>
+struct Base_eval_expr
+  {
+  arma_warn_unused inline Mat<elem_type> eval() const;   //!< force the immediate evaluation of a delayed expression
+  };
+
+
+template<typename elem_type, typename derived, bool condition>
+struct Base_eval {};
+
+template<typename elem_type, typename derived>
+struct Base_eval<elem_type, derived, true>  { typedef Base_eval_Mat<elem_type, derived>  result; };
+
+template<typename elem_type, typename derived>
+struct Base_eval<elem_type, derived, false> { typedef Base_eval_expr<elem_type, derived> result; };
+
+
+
+template<typename derived>
+struct Base_trans_cx
+  {
+  arma_warn_unused arma_inline const Op<derived,op_htrans>  t() const;
+  arma_warn_unused arma_inline const Op<derived,op_htrans> ht() const;
+  arma_warn_unused arma_inline const Op<derived,op_strans> st() const;  // simple transpose: no complex conjugates
+  };
+
+
+template<typename derived>
+struct Base_trans_default
+  {
+  arma_warn_unused arma_inline const Op<derived,op_htrans>  t() const;
+  arma_warn_unused arma_inline const Op<derived,op_htrans> ht() const;
+  arma_warn_unused arma_inline const Op<derived,op_htrans> st() const;  // return op_htrans instead of op_strans, as it's handled better by matrix multiplication code
+  };
+
+
+template<typename derived, bool condition>
+struct Base_trans {};
+
+template<typename derived>
+struct Base_trans<derived, true>  { typedef Base_trans_cx<derived>      result; };
+
+template<typename derived>
+struct Base_trans<derived, false> { typedef Base_trans_default<derived> result; };
+
+
+
+//! Class for static polymorphism, modelled after the "Curiously Recurring Template Pattern" (CRTP).
+//! Used for type-safe downcasting in functions that restrict their input(s) to be classes that are
+//! derived from Base (eg. Mat, Op, Glue, diagview, subview).
+//! A Base object can be converted to a Mat object by the unwrap class.
+
+template<typename elem_type, typename derived>
+struct Base
+  : public Base_extra<elem_type, derived, is_supported_blas_type<elem_type>::value>::result
+  , public Base_eval<elem_type, derived, is_Mat<derived>::value>::result
+  , public Base_trans<derived, is_cx<elem_type>::value>::result
+  {
+  arma_inline const derived& get_ref() const;
+  
+  arma_cold inline void print(                           const std::string extra_text = "") const;
+  arma_cold inline void print(std::ostream& user_stream, const std::string extra_text = "") const;
+  
+  arma_cold inline void raw_print(                           const std::string extra_text = "") const;
+  arma_cold inline void raw_print(std::ostream& user_stream, const std::string extra_text = "") const;
+  
+  arma_cold inline void brief_print(                           const std::string extra_text = "") const;
+  arma_cold inline void brief_print(std::ostream& user_stream, const std::string extra_text = "") const;
+  
+  arma_warn_unused inline elem_type min() const;
+  arma_warn_unused inline elem_type max() const;
+  
+  inline elem_type min(uword& index_of_min_val) const;
+  inline elem_type max(uword& index_of_max_val) const;
+  
+  inline elem_type min(uword& row_of_min_val, uword& col_of_min_val) const;
+  inline elem_type max(uword& row_of_max_val, uword& col_of_max_val) const;
+  
+  arma_warn_unused inline uword index_min() const;
+  arma_warn_unused inline uword index_max() const;
+  
+  arma_warn_unused inline bool is_symmetric() const;
+  arma_warn_unused inline bool is_symmetric(const typename get_pod_type<elem_type>::result tol) const;
+  
+  arma_warn_unused inline bool is_hermitian() const;
+  arma_warn_unused inline bool is_hermitian(const typename get_pod_type<elem_type>::result tol) const;
+  
+  arma_warn_unused inline bool is_zero(const typename get_pod_type<elem_type>::result tol = 0) const;
+  
+  arma_warn_unused inline bool is_trimatu() const;
+  arma_warn_unused inline bool is_trimatl() const;
+  arma_warn_unused inline bool is_diagmat() const;
+  arma_warn_unused inline bool is_empty()   const;
+  arma_warn_unused inline bool is_square()  const;
+  arma_warn_unused inline bool is_vec()     const;
+  arma_warn_unused inline bool is_colvec()  const;
+  arma_warn_unused inline bool is_rowvec()  const;
+  arma_warn_unused inline bool is_finite()  const;
+  
+  arma_warn_unused inline bool has_inf()       const;
+  arma_warn_unused inline bool has_nan()       const;
+  arma_warn_unused inline bool has_nonfinite() const;
+  
+  arma_warn_unused inline const Op<derived,op_vectorise_col> as_col() const;
+  arma_warn_unused inline const Op<derived,op_vectorise_row> as_row() const;
+  };
+
+
+
+//! @}