min.h 2.44 KB
Newer Older
thomas.forbriger's avatar
thomas.forbriger committed
1
2
3
4
5
/*! \file min.h
 * \brief return minimum element value (prototypes)
 * 
 * ----------------------------------------------------------------------------
 * 
thomas.forbriger's avatar
thomas.forbriger committed
6
 * $Id: min.h,v 1.3 2005-04-28 11:38:05 tforb Exp $
thomas.forbriger's avatar
thomas.forbriger committed
7
8
9
10
11
12
13
14
15
 * \author Thomas Forbriger
 * \date 20/03/2005
 * 
 * return minimum element value (prototypes)
 * 
 * Copyright (c) 2005 by Thomas Forbriger (BFO Schiltach) 
 * 
 * REVISIONS and CHANGES 
 *  - 20/03/2005   V1.0   Thomas Forbriger
thomas.forbriger's avatar
thomas.forbriger committed
16
 *  - 28/04/2005   V1.1   provide return type
thomas.forbriger's avatar
thomas.forbriger committed
17
18
19
20
21
22
23
24
 * 
 * ============================================================================
 */

// include guard
#ifndef AFF_MIN_H_VERSION

#define AFF_MIN_H_VERSION \
thomas.forbriger's avatar
thomas.forbriger committed
25
  "AFF_MIN_H   V1.1   "
thomas.forbriger's avatar
thomas.forbriger committed
26
#define AFF_MIN_H_CVSID \
thomas.forbriger's avatar
thomas.forbriger committed
27
  "$Id: min.h,v 1.3 2005-04-28 11:38:05 tforb Exp $"
thomas.forbriger's avatar
thomas.forbriger committed
28
29


thomas.forbriger's avatar
thomas.forbriger committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
#include<aff/lib/collector.h>

namespace aff {

  namespace func {

    namespace util {

      /*! utility class to extract the smallest value from a container
       *
       * This class should be used together with the
       * aff::func::util::collect() function template.
       *
       * \param C any container class like aff::Array<double>
       */
      template<class C>
        class Extractmin {
          typedef typename C::Tcoc Tcont;
          typedef typename C::Tvalue Tvalue;
          public:
thomas.forbriger's avatar
thomas.forbriger committed
50
            typedef Tvalue Tretval;
thomas.forbriger's avatar
thomas.forbriger committed
51
52
53
54
55
56
            //! initialize member data
            Extractmin(const Tcont& c): Mval(c(c.first())) { }
            //! collect another value
            void operator() (const Tvalue& v) 
            { Mval = Mval < v ? Mval : v; }
            //! return result of operation
thomas.forbriger's avatar
thomas.forbriger committed
57
            Tretval result() const { return(Mval); }
thomas.forbriger's avatar
thomas.forbriger committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
          private:
            Tvalue Mval;
        }; // class Extractmin
      
    } // namespace util

/*----------------------------------------------------------------------*/

    /*! Function template to extract the smallest from the values
     *  stored in a container
     *
     * \param C any container class like aff::Array<double>
     *          (this value is deduced by the compiler)
     * \param c any container of numerical values
     * \return smallest value of container contents
     *
     * \sa aff::func::util::collect, aff::func::util::Extractmin
     */
    template<class C>
      typename C::Tvalue min(const C& c)
      {
        return(aff::func::util::collect<C, aff::func::util::Extractmin>(c));
      } // min()

  } // namespace func

} // namespace aff
thomas.forbriger's avatar
thomas.forbriger committed
85
86
87
88

#endif // AFF_MIN_H_VERSION (includeguard)

/* ----- END OF min.h ----- */