max.h

Go to the documentation of this file.

 
// max.h: Rcpp R/C++ interface class library -- max
//
// Copyright (C) 2012 - 2025  Dirk Eddelbuettel and Romain Francois
// Copyright (C) 2026         Dirk Eddelbuettel, Romain Francois and Iñaki Ucar
//
// This file is part of Rcpp.
//
// Rcpp is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 2 of the License, or
// (at your option) any later version.
//
// Rcpp is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Rcpp.  If not, see <http://www.gnu.org/licenses/>.
 
#ifndef Rcpp__sugar__max_h
#define Rcpp__sugar__max_h
 
namespace Rcpp{
namespace sugar{
 
    template <int RTYPE, bool NA, typename T>
    class Max {
    public:
        typedef typename Rcpp::traits::storage_type<RTYPE>::type STORAGE ;
 
        Max( const T& obj_) : obj(obj_) {}
 
        operator STORAGE() const {
            R_xlen_t n = obj.size();
            if (n == 0) {
                if (RTYPE != REALSXP)
                    Rcpp::stop("missing argument to max");
                return(static_cast<STORAGE>(R_NegInf));
            }
 
            STORAGE max, current ;
            max = obj[0] ;
            if( Rcpp::traits::is_na<RTYPE>( max ) ) return max ;
            for( R_xlen_t i=1; i<n; i++){
                current = obj[i] ;
                if( Rcpp::traits::is_na<RTYPE>( current ) ) return current;
                if( current > max ) max = current ;
            }
            return max ;
        }
 
    private:
        const T& obj ;
    } ;
 
    // version for NA = false
    template <int RTYPE, typename T>
    class Max<RTYPE,false,T> {
    public:
        typedef typename Rcpp::traits::storage_type<RTYPE>::type STORAGE ;
 
        Max( const T& obj_) : obj(obj_) {}
 
        operator STORAGE() const {
            R_xlen_t n = obj.size();
            if (n == 0) {
                if (RTYPE != REALSXP)
                    Rcpp::stop("missing argument to max");
                return(static_cast<STORAGE>(R_NegInf));
            }
 
            STORAGE max, current ;
            max = obj[0] ;
            for( R_xlen_t i=1; i<n; i++){
                current = obj[i] ;
                if( current > max ) max = current ;
            }
            return max ;
        }
 
    private:
        const T& obj ;
    } ;
 
 
} // sugar
 
template <int RTYPE, bool NA, typename T>
sugar::Max<RTYPE,NA,T> max( const VectorBase<RTYPE,NA,T>& x){
    return sugar::Max<RTYPE,NA,T>(x.get_ref()) ;
}
 
} // Rcpp
 
#endif