// 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 fn_conv_to //! @{ //! conversion from Armadillo Base and BaseCube objects to scalars //! NOTE: use as_scalar() instead; this functionality is kept only for compatibility with old user code template class conv_to { public: template arma_frown("use as_scalar() instead") inline static out_eT from(const Base& in, const typename arma_not_cx::result* junk = nullptr); template arma_frown("use as_scalar() instead") inline static out_eT from(const Base& in, const typename arma_cx_only::result* junk = nullptr); template arma_frown("use as_scalar() instead") inline static out_eT from(const BaseCube& in, const typename arma_not_cx::result* junk = nullptr); template arma_frown("use as_scalar() instead") inline static out_eT from(const BaseCube& in, const typename arma_cx_only::result* junk = nullptr); }; template template arma_warn_unused inline out_eT conv_to::from(const Base& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); arma_type_check(( is_supported_elem_type::value == false )); const Proxy P(in.get_ref()); arma_conform_check( (P.get_n_elem() != 1), "conv_to(): expected 1x1 matrix" ); return out_eT(Proxy::use_at ? P.at(0,0) : P[0]); } template template arma_warn_unused inline out_eT conv_to::from(const Base& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); arma_type_check(( is_supported_elem_type::value == false )); const Proxy P(in.get_ref()); arma_conform_check( (P.get_n_elem() != 1), "conv_to(): expected 1x1 matrix" ); out_eT out; arrayops::convert_cx_scalar(out, (Proxy::use_at ? P.at(0,0) : P[0])); return out; } template template arma_warn_unused inline out_eT conv_to::from(const BaseCube& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); arma_type_check(( is_supported_elem_type::value == false )); const ProxyCube P(in.get_ref()); arma_conform_check( (P.get_n_elem() != 1), "conv_to(): expected 1x1x1 cube" ); return out_eT(ProxyCube::use_at ? P.at(0,0,0) : P[0]); } template template arma_warn_unused inline out_eT conv_to::from(const BaseCube& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); arma_type_check(( is_supported_elem_type::value == false )); const ProxyCube P(in.get_ref()); arma_conform_check( (P.get_n_elem() != 1), "conv_to(): expected 1x1x1 cube" ); out_eT out; arrayops::convert_cx_scalar(out, (ProxyCube::use_at ? P.at(0,0,0) : P[0])); return out; } //! conversion to Armadillo matrices from Armadillo Base objects, as well as from std::vector template class conv_to< Mat > { public: template inline static Mat from(const Base& in, const typename arma_not_cx::result* junk = nullptr); template inline static Mat from(const Base& in, const typename arma_cx_only::result* junk = nullptr); // template inline static Mat from(const SpBase& in, const typename arma_not_cx::result* junk = nullptr); template inline static Mat from(const SpBase& in, const typename arma_cx_only::result* junk = nullptr); // template inline static Mat from(const std::vector& in, const typename arma_not_cx::result* junk = nullptr); template inline static Mat from(const std::vector& in, const typename arma_cx_only::result* junk = nullptr); }; template template arma_warn_unused inline Mat conv_to< Mat >::from(const Base& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; Mat out(X.n_rows, X.n_cols, arma_nozeros_indicator()); arrayops::convert( out.memptr(), X.memptr(), X.n_elem ); return out; } template template arma_warn_unused inline Mat conv_to< Mat >::from(const Base& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; Mat out(X.n_rows, X.n_cols, arma_nozeros_indicator()); arrayops::convert_cx( out.memptr(), X.memptr(), X.n_elem ); return out; } template template arma_warn_unused inline Mat conv_to< Mat >::from(const SpBase& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const unwrap_spmat U(in.get_ref()); const SpMat& X = U.M; Mat out(X.n_rows, X.n_cols, arma_zeros_indicator()); podarray tmp(X.n_nonzero); arrayops::convert( tmp.memptr(), X.values, X.n_nonzero ); typename SpMat::const_iterator it = X.begin(); typename SpMat::const_iterator it_end = X.end(); for(uword count=0; it != it_end; ++it, ++count) { out.at(it.row(), it.col()) = tmp[count]; } return out; } template template arma_warn_unused inline Mat conv_to< Mat >::from(const SpBase& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const unwrap_spmat U(in.get_ref()); const SpMat& X = U.M; Mat out(X.n_rows, X.n_cols, arma_zeros_indicator()); podarray tmp(X.n_nonzero); arrayops::convert_cx( tmp.memptr(), X.values, X.n_nonzero ); typename SpMat::const_iterator it = X.begin(); typename SpMat::const_iterator it_end = X.end(); for(uword count=0; it != it_end; ++it, ++count) { out.at(it.row(), it.col()) = tmp[count]; } return out; } template template arma_warn_unused inline Mat conv_to< Mat >::from(const std::vector& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const uword N = uword( in.size() ); Mat out(N, 1, arma_nozeros_indicator()); if(N > 0) { arrayops::convert( out.memptr(), &(in[0]), N ); } return out; } template template arma_warn_unused inline Mat conv_to< Mat >::from(const std::vector& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const uword N = uword( in.size() ); Mat out(N, 1, arma_nozeros_indicator()); if(N > 0) { arrayops::convert_cx( out.memptr(), &(in[0]), N ); } return out; } //! conversion to Armadillo row vectors from Armadillo Base objects, as well as from std::vector template class conv_to< Row > { public: template inline static Row from(const Base& in, const typename arma_not_cx::result* junk = nullptr); template inline static Row from(const Base& in, const typename arma_cx_only::result* junk = nullptr); // template inline static Row from(const std::vector& in, const typename arma_not_cx::result* junk = nullptr); template inline static Row from(const std::vector& in, const typename arma_cx_only::result* junk = nullptr); }; template template arma_warn_unused inline Row conv_to< Row >::from(const Base& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; arma_conform_check( ( (X.is_vec() == false) && (X.is_empty() == false) ), "conv_to(): given object cannot be interpreted as a vector" ); Row out(X.n_elem, arma_nozeros_indicator()); arrayops::convert( out.memptr(), X.memptr(), X.n_elem ); return out; } template template arma_warn_unused inline Row conv_to< Row >::from(const Base& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; arma_conform_check( ( (X.is_vec() == false) && (X.is_empty() == false) ), "conv_to(): given object cannot be interpreted as a vector" ); Row out(X.n_rows, X.n_cols, arma_nozeros_indicator()); arrayops::convert_cx( out.memptr(), X.memptr(), X.n_elem ); return out; } template template arma_warn_unused inline Row conv_to< Row >::from(const std::vector& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const uword N = uword( in.size() ); Row out(N, arma_nozeros_indicator()); if(N > 0) { arrayops::convert( out.memptr(), &(in[0]), N ); } return out; } template template arma_warn_unused inline Row conv_to< Row >::from(const std::vector& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const uword N = uword( in.size() ); Row out(N, arma_nozeros_indicator()); if(N > 0) { arrayops::convert_cx( out.memptr(), &(in[0]), N ); } return out; } //! conversion to Armadillo column vectors from Armadillo Base objects, as well as from std::vector template class conv_to< Col > { public: template inline static Col from(const Base& in, const typename arma_not_cx::result* junk = nullptr); template inline static Col from(const Base& in, const typename arma_cx_only::result* junk = nullptr); // template inline static Col from(const std::vector& in, const typename arma_not_cx::result* junk = nullptr); template inline static Col from(const std::vector& in, const typename arma_cx_only::result* junk = nullptr); }; template template arma_warn_unused inline Col conv_to< Col >::from(const Base& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; arma_conform_check( ( (X.is_vec() == false) && (X.is_empty() == false) ), "conv_to(): given object cannot be interpreted as a vector" ); Col out(X.n_elem, arma_nozeros_indicator()); arrayops::convert( out.memptr(), X.memptr(), X.n_elem ); return out; } template template arma_warn_unused inline Col conv_to< Col >::from(const Base& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; arma_conform_check( ( (X.is_vec() == false) && (X.is_empty() == false) ), "conv_to(): given object cannot be interpreted as a vector" ); Col out(X.n_rows, X.n_cols, arma_nozeros_indicator()); arrayops::convert_cx( out.memptr(), X.memptr(), X.n_elem ); return out; } template template arma_warn_unused inline Col conv_to< Col >::from(const std::vector& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const uword N = uword( in.size() ); Col out(N, arma_nozeros_indicator()); if(N > 0) { arrayops::convert( out.memptr(), &(in[0]), N ); } return out; } template template arma_warn_unused inline Col conv_to< Col >::from(const std::vector& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const uword N = uword( in.size() ); Col out(N, arma_nozeros_indicator()); if(N > 0) { arrayops::convert_cx( out.memptr(), &(in[0]), N ); } return out; } //! convert between SpMat types template class conv_to< SpMat > { public: template inline static SpMat from(const SpBase& in, const typename arma_not_cx::result* junk = nullptr); template inline static SpMat from(const SpBase& in, const typename arma_cx_only::result* junk = nullptr); // template inline static SpMat from(const Base& in, const typename arma_not_cx::result* junk = nullptr); template inline static SpMat from(const Base& in, const typename arma_cx_only::result* junk = nullptr); }; template template arma_warn_unused inline SpMat conv_to< SpMat >::from(const SpBase& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const unwrap_spmat tmp(in.get_ref()); const SpMat& X = tmp.M; SpMat out(arma_layout_indicator(), X); arrayops::convert( access::rwp(out.values), X.values, X.n_nonzero ); out.remove_zeros(); return out; } template template arma_warn_unused inline SpMat conv_to< SpMat >::from(const SpBase& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const unwrap_spmat tmp(in.get_ref()); const SpMat& X = tmp.M; SpMat out(arma_layout_indicator(), X); arrayops::convert_cx( access::rwp(out.values), X.values, X.n_nonzero ); out.remove_zeros(); return out; } template template arma_warn_unused inline SpMat conv_to< SpMat >::from(const Base& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); SpMat out; const quasi_unwrap U(in.get_ref()); const Mat& X = U.M; if(is_same_type::yes) { const Mat& Y = reinterpret_cast&>(X); SpMat tmp(Y); out.steal_mem(tmp); } else { const uword X_n_rows = X.n_rows; const uword X_n_cols = X.n_cols; const uword X_n_elem = X.n_elem; const in_eT* X_mem = X.memptr(); uword X_nnz = 0; for(uword i=0; i < X_n_elem; ++i) { X_nnz += (X_mem[i] != in_eT(0)) ? uword(1) : uword(0); } podarray< in_eT> X_nonzeros(X_nnz); podarray Y_nonzeros(X_nnz); for(uword i=0,count=0; i < X_n_elem; ++i) { const in_eT X_val = X_mem[i]; if(X_val != in_eT(0)) { X_nonzeros[count] = X_val; ++count; } } arrayops::convert( Y_nonzeros.memptr(), X_nonzeros.memptr(), X_nnz ); if(X_nnz == 0) { out.set_size(X_n_rows, X.n_cols); } else { SpMat tmp(arma_reserve_indicator(), X_n_rows, X_n_cols, X_nnz); uword count = 0; for(uword c=0; c < X_n_cols; ++c) for(uword r=0; r < X_n_rows; ++r) { const in_eT X_val = (*X_mem); ++X_mem; if(X_val != in_eT(0)) { access::rw(tmp.values[count]) = Y_nonzeros[count]; access::rw(tmp.row_indices[count]) = r; access::rw(tmp.col_ptrs[c + 1])++; ++count; } } // Sum column counts to be column pointers. for(uword c=1; c <= tmp.n_cols; ++c) { access::rw(tmp.col_ptrs[c]) += tmp.col_ptrs[c - 1]; } tmp.remove_zeros(); // in case conversion resulted in an element equal to zero out.steal_mem(tmp); } } return out; } template template arma_warn_unused inline SpMat conv_to< SpMat >::from(const Base& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); SpMat out; const quasi_unwrap U(in.get_ref()); const Mat& X = U.M; if(is_same_type::yes) { const Mat& Y = reinterpret_cast&>(X); SpMat tmp(Y); out.steal_mem(tmp); } else { const uword X_n_rows = X.n_rows; const uword X_n_cols = X.n_cols; const uword X_n_elem = X.n_elem; const in_eT* X_mem = X.memptr(); uword X_nnz = 0; for(uword i=0; i < X_n_elem; ++i) { X_nnz += (X_mem[i] != in_eT(0)) ? uword(1) : uword(0); } podarray< in_eT> X_nonzeros(X_nnz); podarray Y_nonzeros(X_nnz); for(uword i=0,count=0; i < X_n_elem; ++i) { const in_eT X_val = X_mem[i]; if(X_val != in_eT(0)) { X_nonzeros[count] = X_val; ++count; } } arrayops::convert_cx( Y_nonzeros.memptr(), X_nonzeros.memptr(), X_nnz ); if(X_nnz == 0) { out.set_size(X_n_rows, X.n_cols); } else { SpMat tmp(arma_reserve_indicator(), X_n_rows, X_n_cols, X_nnz); uword count = 0; for(uword c=0; c < X_n_cols; ++c) for(uword r=0; r < X_n_rows; ++r) { const in_eT X_val = (*X_mem); ++X_mem; if(X_val != in_eT(0)) { access::rw(tmp.values[count]) = Y_nonzeros[count]; access::rw(tmp.row_indices[count]) = r; access::rw(tmp.col_ptrs[c + 1])++; ++count; } } // Sum column counts to be column pointers. for(uword c=1; c <= tmp.n_cols; ++c) { access::rw(tmp.col_ptrs[c]) += tmp.col_ptrs[c - 1]; } tmp.remove_zeros(); // in case conversion resulted in an element equal to zero out.steal_mem(tmp); } } return out; } //! conversion to Armadillo cubes from Armadillo BaseCube objects template class conv_to< Cube > { public: template inline static Cube from(const BaseCube& in, const typename arma_not_cx::result* junk = nullptr); template inline static Cube from(const BaseCube& in, const typename arma_cx_only::result* junk = nullptr); }; template template arma_warn_unused inline Cube conv_to< Cube >::from(const BaseCube& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const unwrap_cube tmp( in.get_ref() ); const Cube& X = tmp.M; Cube out(X.n_rows, X.n_cols, X.n_slices, arma_nozeros_indicator()); arrayops::convert( out.memptr(), X.memptr(), X.n_elem ); return out; } template template arma_warn_unused inline Cube conv_to< Cube >::from(const BaseCube& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const unwrap_cube tmp( in.get_ref() ); const Cube& X = tmp.M; Cube out(X.n_rows, X.n_cols, X.n_slices, arma_nozeros_indicator()); arrayops::convert_cx( out.memptr(), X.memptr(), X.n_elem ); return out; } //! conversion to std::vector from Armadillo Base objects template class conv_to< std::vector > { public: template inline static std::vector from(const Base& in, const typename arma_not_cx::result* junk = nullptr); template inline static std::vector from(const Base& in, const typename arma_cx_only::result* junk = nullptr); }; template template arma_warn_unused inline std::vector conv_to< std::vector >::from(const Base& in, const typename arma_not_cx::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; arma_conform_check( ( (X.is_vec() == false) && (X.is_empty() == false) ), "conv_to(): given object cannot be interpreted as a vector" ); const uword N = X.n_elem; std::vector out(N); if(N > 0) { arrayops::convert( &(out[0]), X.memptr(), N ); } return out; } template template arma_warn_unused inline std::vector conv_to< std::vector >::from(const Base& in, const typename arma_cx_only::result* junk) { arma_debug_sigprint(); arma_ignore(junk); const quasi_unwrap tmp(in.get_ref()); const Mat& X = tmp.M; arma_conform_check( ( (X.is_vec() == false) && (X.is_empty() == false) ), "conv_to(): given object cannot be interpreted as a vector" ); const uword N = X.n_elem; std::vector out(N); if(N > 0) { arrayops::convert_cx( &(out[0]), X.memptr(), N ); } return out; } //! @}