annotate armadillo-2.4.4/include/armadillo_bits/fn_max.hpp @ 18:8d046a9d36aa slimline

Back out rev 13:ac07c60aa798. Like an idiot, I committed a whole pile of unrelated changes in the guise of a single typo fix. Will re-commit in stages
author Chris Cannam
date Thu, 10 May 2012 10:45:44 +0100
parents 8b6102e2a9b0
children
rev   line source
max@0 1 // Copyright (C) 2008-2011 NICTA (www.nicta.com.au)
max@0 2 // Copyright (C) 2008-2011 Conrad Sanderson
max@0 3 //
max@0 4 // This file is part of the Armadillo C++ library.
max@0 5 // It is provided without any warranty of fitness
max@0 6 // for any purpose. You can redistribute this file
max@0 7 // and/or modify it under the terms of the GNU
max@0 8 // Lesser General Public License (LGPL) as published
max@0 9 // by the Free Software Foundation, either version 3
max@0 10 // of the License or (at your option) any later version.
max@0 11 // (see http://www.opensource.org/licenses for more info)
max@0 12
max@0 13
max@0 14 //! \addtogroup fn_max
max@0 15 //! @{
max@0 16
max@0 17
max@0 18 //! \brief
max@0 19 //! Delayed 'maximum values' operation.
max@0 20 //! The dimension, along which the maxima are found, is set via 'dim'.
max@0 21 //! For dim = 0, the maximum value of each column is found (i.e. searches by traversing across rows).
max@0 22 //! For dim = 1, the maximum value of each row is found (i.e. searches by traversing across columns).
max@0 23 //! The default is dim = 0.
max@0 24
max@0 25 template<typename T1>
max@0 26 arma_inline
max@0 27 const Op<T1, op_max>
max@0 28 max(const Base<typename T1::elem_type,T1>& X, const uword dim = 0)
max@0 29 {
max@0 30 arma_extra_debug_sigprint();
max@0 31
max@0 32 return Op<T1, op_max>(X.get_ref(), dim, 0);
max@0 33 }
max@0 34
max@0 35
max@0 36 //! Immediate 'find the maximum value in a row vector' operation
max@0 37 template<typename eT>
max@0 38 inline
max@0 39 arma_warn_unused
max@0 40 eT
max@0 41 max(const Row<eT>& A)
max@0 42 {
max@0 43 arma_extra_debug_sigprint();
max@0 44
max@0 45 const uword A_n_elem = A.n_elem;
max@0 46
max@0 47 arma_debug_check( (A_n_elem == 0), "max(): given object has no elements" );
max@0 48
max@0 49 return op_max::direct_max(A.mem, A_n_elem);
max@0 50 }
max@0 51
max@0 52
max@0 53
max@0 54 //! Immediate 'find the maximum value in a column vector' operation
max@0 55 template<typename eT>
max@0 56 inline
max@0 57 arma_warn_unused
max@0 58 eT
max@0 59 max(const Col<eT>& A)
max@0 60 {
max@0 61 arma_extra_debug_sigprint();
max@0 62
max@0 63 const uword A_n_elem = A.n_elem;
max@0 64
max@0 65 arma_debug_check( (A_n_elem == 0), "max(): given object has no elements" );
max@0 66
max@0 67 return op_max::direct_max(A.mem, A_n_elem);
max@0 68 }
max@0 69
max@0 70
max@0 71
max@0 72 //! \brief
max@0 73 //! Immediate 'find maximum value' operation,
max@0 74 //! invoked, for example, by: max(max(A))
max@0 75 template<typename T1>
max@0 76 inline
max@0 77 arma_warn_unused
max@0 78 typename T1::elem_type
max@0 79 max(const Op<T1, op_max>& in)
max@0 80 {
max@0 81 arma_extra_debug_sigprint();
max@0 82 arma_extra_debug_print("max(): two consecutive max() calls detected");
max@0 83
max@0 84 typedef typename T1::elem_type eT;
max@0 85
max@0 86 const unwrap<T1> tmp1(in.m);
max@0 87 const Mat<eT>& X = tmp1.M;
max@0 88
max@0 89 const uword X_n_elem = X.n_elem;
max@0 90
max@0 91 arma_debug_check( (X_n_elem == 0), "max(): given object has no elements" );
max@0 92
max@0 93 return op_max::direct_max(X.mem, X_n_elem);
max@0 94 }
max@0 95
max@0 96
max@0 97
max@0 98 template<typename T1>
max@0 99 arma_inline
max@0 100 const Op< Op<T1, op_max>, op_max>
max@0 101 max(const Op<T1, op_max>& in, const uword dim)
max@0 102 {
max@0 103 arma_extra_debug_sigprint();
max@0 104
max@0 105 return Op< Op<T1, op_max>, op_max>(in, dim, 0);
max@0 106 }
max@0 107
max@0 108
max@0 109
max@0 110 template<typename eT>
max@0 111 inline
max@0 112 arma_warn_unused
max@0 113 eT
max@0 114 max(const subview_row<eT>& A)
max@0 115 {
max@0 116 arma_extra_debug_sigprint();
max@0 117
max@0 118 arma_debug_check( (A.n_elem == 0), "max(): given object has no elements" );
max@0 119
max@0 120 return op_max::direct_max(A);
max@0 121 }
max@0 122
max@0 123
max@0 124
max@0 125 template<typename eT>
max@0 126 inline
max@0 127 arma_warn_unused
max@0 128 eT
max@0 129 max(const subview_col<eT>& A)
max@0 130 {
max@0 131 arma_extra_debug_sigprint();
max@0 132
max@0 133 arma_debug_check( (A.n_elem == 0), "max(): given object has no elements" );
max@0 134
max@0 135 return op_max::direct_max(A.colptr(0), A.n_rows);
max@0 136 }
max@0 137
max@0 138
max@0 139
max@0 140 template<typename eT>
max@0 141 inline
max@0 142 arma_warn_unused
max@0 143 eT
max@0 144 max(const Op<subview<eT>, op_max>& in)
max@0 145 {
max@0 146 arma_extra_debug_sigprint();
max@0 147 arma_extra_debug_print("max(): two consecutive max() calls detected");
max@0 148
max@0 149 const subview<eT>& X = in.m;
max@0 150
max@0 151 arma_debug_check( (X.n_elem == 0), "max(): given object has no elements" );
max@0 152
max@0 153 return op_max::direct_max(X);
max@0 154 }
max@0 155
max@0 156
max@0 157
max@0 158 template<typename eT>
max@0 159 inline
max@0 160 arma_warn_unused
max@0 161 eT
max@0 162 max(const diagview<eT>& A)
max@0 163 {
max@0 164 arma_extra_debug_sigprint();
max@0 165
max@0 166 arma_debug_check( (A.n_elem == 0), "max(): given object has no elements" );
max@0 167
max@0 168 return op_max::direct_max(A);
max@0 169 }
max@0 170
max@0 171
max@0 172
max@0 173 template<typename eT, typename T1>
max@0 174 inline
max@0 175 arma_warn_unused
max@0 176 eT
max@0 177 max(const subview_elem1<eT,T1>& A)
max@0 178 {
max@0 179 arma_extra_debug_sigprint();
max@0 180
max@0 181 const Mat<eT> X(A);
max@0 182
max@0 183 const uword X_n_elem = X.n_elem;
max@0 184
max@0 185 arma_debug_check( (X_n_elem == 0), "max(): given object has no elements" );
max@0 186
max@0 187 return op_max::direct_max(X.mem, X_n_elem);
max@0 188 }
max@0 189
max@0 190
max@0 191
max@0 192 //! @}