Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
rectangularity.hh
1 // Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE)
2 //
3 // This file is part of Olena.
4 //
5 // Olena is free software: you can redistribute it and/or modify it under
6 // the terms of the GNU General Public License as published by the Free
7 // Software Foundation, version 2 of the License.
8 //
9 // Olena is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Olena. If not, see <http://www.gnu.org/licenses/>.
16 //
17 // As a special exception, you may use this file as part of a free
18 // software project without restriction. Specifically, if other files
19 // instantiate templates or use macros or inline functions from this
20 // file, or you compile this file and link it with other files to produce
21 // an executable, this file does not by itself cause the resulting
22 // executable to be covered by the GNU General Public License. This
23 // exception does not however invalidate any other reasons why the
24 // executable file might be covered by the GNU General Public License.
25 
26 #ifndef MLN_ACCU_SITE_SET_RECTANGULARITY_HH
27 # define MLN_ACCU_SITE_SET_RECTANGULARITY_HH
28 
32 
33 # include <mln/accu/internal/couple.hh>
34 # include <mln/accu/shape/bbox.hh>
35 # include <mln/accu/math/count.hh>
36 
37 namespace mln
38 {
39 
40  namespace accu
41  {
42 
43  namespace site_set
44  {
45 
49  //
50  template <typename P>
52  : public accu::internal::couple<accu::shape::bbox<P>,
53  accu::math::count<P>,
54  float,
55  rectangularity<P> >
56  {
57 
58  public:
59 
60  typedef accu::internal::couple<accu::shape::bbox<P>,
62  float,
63  rectangularity<P> > super_;
64 
65  typedef accu::shape::bbox<P> A1;
66  typedef accu::math::count<P> A2;
67 
68  typedef float result;
69 
72 
74  mln_result(A1) bbox() const;
76  mln_result(A2) area() const;
77 
79  result to_result() const;
80 
81  protected:
82  using super_::a1_;
83  using super_::a2_;
84 
85  };
86 
87 # ifndef MLN_INCLUDE_ONLY
88 
89  template <typename P>
90  inline
92  {
93  }
94 
95  template <typename P>
96  inline
97  mln_result(rectangularity<P>::A1)
98  rectangularity<P>::bbox() const
99  {
100  mln_precondition(a1_.is_valid());
101  return a1_.to_result();
102  }
103 
104  template <typename P>
105  inline
106  mln_result(rectangularity<P>::A2)
107  rectangularity<P>::area() const
108  {
109  mln_precondition(a2_.is_valid());
110  return a2_.to_result();
111  }
112 
113  template <typename P>
114  inline
115  mln_result(rectangularity<P>)
116  rectangularity<P>::to_result() const
117  {
118  mln_precondition(this->is_valid());
119  // Force division return type.
120  return static_cast<result>(a2_.to_result()) / a1_.to_result().nsites();
121  }
122 
123 # endif // ! MLN_INCLUDE_ONLY
124 
125  } // end of namespace mln::accu::site_set
126 
127  } // end of namespace mln::accu
128 
129 } // end of namespace mln
130 
131 #endif // ! MLN_ACCU_SITE_SET_RECTANGULARITY_HH