Fawkes API  Fawkes Development Version
probability.h
1 
2 /***************************************************************************
3  * probability.h - Probability typedef
4  *
5  * Created: Fri Oct 18 15:16:23 2013
6  * Copyright 2002 AllemaniACs
7  * 2013 Bahram Maleki-Fard
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Library General Public License for more details.
19  *
20  * Read the full text in the LICENSE.GPL file in the doc directory.
21  */
22 
23 #ifndef __PLUGINS_COLLI_UTILS_OCCUPANCYGRID_PROBABILITY_H_
24 #define __PLUGINS_COLLI_UTILS_OCCUPANCYGRID_PROBABILITY_H_
25 
26 namespace fawkes
27 {
28 #if 0 /* just to make Emacs auto-indent happy */
29 }
30 #endif
31 
32 /** A probability type. */
33 typedef float Probability;
34 
35 /** Check if the probability value is valid.
36  * @param p The probablity
37  * @return true if valid, false otherwise
38  */
39 inline bool
41 {
42  return ((p >= 0) && (p <= 1));
43 }
44 
45 } // namespace fawkes
46 
47 #endif
float Probability
A probability type.
Definition: probability.h:33
Fawkes library namespace.
bool isProb(Probability p)
Check if the probability value is valid.
Definition: probability.h:40