DGtal  0.9.2
Measure.ih
1 /**
2  * This program is free software: you can redistribute it and/or modify
3  * it under the terms of the GNU Lesser General Public License as
4  * published by the Free Software Foundation, either version 3 of the
5  * License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program. If not, see <http://www.gnu.org/licenses/>.
14  *
15  **/
16 
17 /**
18  * @file Measure.ih
19  * @author David Coeurjolly (\c david.coeurjolly@liris.cnrs.fr )
20  * Laboratoire d'InfoRmatique en Image et Systèmes d'information - LIRIS (CNRS, UMR 5205), CNRS, France
21  *
22  * @date 2011/06/25
23  *
24  * Implementation of inline methods defined in Measure.h
25  *
26  * This file is part of the DGtal library.
27  */
28 
29 
30 //////////////////////////////////////////////////////////////////////////////
31 #include <cstdlib>
32 //////////////////////////////////////////////////////////////////////////////
33 
34 ///////////////////////////////////////////////////////////////////////////////
35 // IMPLEMENTATION of inline methods.
36 ///////////////////////////////////////////////////////////////////////////////
37 
38 ///////////////////////////////////////////////////////////////////////////////
39 // ----------------------- Standard services ------------------------------
40 
41 template< typename TSet>
42 inline
43 void
44 DGtal::Measure<TSet>::init(const double h, const TSet &aSet)
45 {
46  myH = h;
47  mySetSize = aSet.size() ;
48  myIsInitBefore = true;
49 }
50 
51 
52 template< typename TSet>
53 inline
54 typename DGtal::Measure<TSet>::Quantity
55 DGtal::Measure<TSet>::eval() const
56 {
57  ASSERT(myIsInitBefore);
58  ASSERT(myH > 0);
59 
60  double hd = std::pow(myH, (double)TSet::Domain::dimension);
61 
62  return mySetSize/(double)hd;
63 }
64 
65 
66 /**
67  * Constructon.
68  */
69 template < typename TSet>
70 inline
71 DGtal::Measure<TSet>::Measure()
72 {
73  myIsInitBefore = false;
74 }
75 
76 
77 /**
78  * Destructor.
79  */
80 template < typename TSet>
81 inline
82 DGtal::Measure<TSet>::~Measure()
83 {
84 }
85 
86 ///////////////////////////////////////////////////////////////////////////////
87 // Interface - public :
88 
89 /**
90  * Writes/Displays the object on an output stream.
91  * @param out the output stream where the object is written.
92  */
93 template < typename TSet>
94 inline
95 void
96 DGtal::Measure<TSet>::selfDisplay ( std::ostream & out ) const
97 {
98  out << "[Measure] ";
99  if (this->isValid())
100  out << " myH="<< myH<<", mySetSize="<< mySetSize;
101  else
102  out <<" (not initialized)";
103 }
104 
105 /**
106  * Checks the validity/consistency of the object.
107  * @return 'true' if the object is valid, 'false' otherwise.
108  */
109 template < typename TSet>
110 inline
111 bool
112 DGtal::Measure<TSet>::isValid() const
113 {
114  return myIsInitBefore;
115 }
116 
117 
118 
119 ///////////////////////////////////////////////////////////////////////////////
120 // Implementation of inline functions //
121 
122 template < typename TSet>
123 inline
124 std::ostream&
125 DGtal::operator<< ( std::ostream & out,
126  const Measure<TSet> & object )
127 {
128  object.selfDisplay( out );
129  return out;
130 }
131 
132 // //
133 ///////////////////////////////////////////////////////////////////////////////
134 
135