Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
is_facet.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_TOPO_IS_FACET_HH
27 # define MLN_TOPO_IS_FACET_HH
28 
31 
32 # include <mln/core/site_set/complex_psite.hh>
33 # include <mln/core/image/complex_neighborhoods.hh>
34 # include <mln/core/image/complex_neighborhood_piter.hh>
35 
36 
37 namespace mln
38 {
39 
40  namespace topo
41  {
42 
43  /* FIXME: Make this routine a method of mln::complex_psite? Or
44  better, a method of mln::topo::face? */
45 
48  template <unsigned D, typename G>
49  bool
50  is_facet(const complex_psite<D, G>& f);
51 
52 
53 # ifndef MLN_INCLUDE_ONLY
54 
55  template <unsigned D, typename G>
56  inline
57  bool
59  {
60  typedef complex_higher_neighborhood<D, G> higher_adj_nbh_t;
61  higher_adj_nbh_t higher_adj_nbh;
62  mln_niter(higher_adj_nbh_t) n(higher_adj_nbh, f);
63  for_all(n)
64  // If the neighborhood is not empty, then F is included in a face
65  // of higher dimension.
66  return false;
67  // Otherwise, F is a facet.
68  return true;
69  }
70 
71 # endif // MLN_INCLUDE_ONLY
72 
73  } // end of namespace mln::topo
74 
75 } // end of namespace mln
76 
77 #endif // ! MLN_TOPO_IS_FACET_HH