Navigation: Up, Table of Contents, Bibliography, Index, Title Page

## CGAL::Filtered_predicate<EP, FP, C2E, C2F>

### Definition

Filtered_predicate<EP, FP, C2E, C2F>is an adaptor for predicate function objects that allows one to produce efficient and exact predicates. It is used to build CGAL::Filtered_kernel<CK, EK, FK, C2E, C2F> and can be used for other predicates too.

EP is the exact but supposedly slow predicate that is able to evaluate the predicate correctly. It will be called only when the filtering predicate, FP, cannot compute the correct result. This failure of FP must be done by throwing an exception.

To convert the geometric objects that are the arguments of the predicate, we use the function objects C2E and C2F, which must be of the form Cartesian_converter or Homogeneous_converter.

#include <CGAL/Filtered_predicate.h>

### Types

typedef FP::result_type
| result_type; | The return type of the function operators. It must also be the same type as EP::result_type.

### Creation

Filtered_predicate<EP, FP, C2E, C2F> fo;
| Default constructor.

### Operations

template <class A1>
result_type | fo.operator() ( A1 a1)
|  | The unary function operator for unary predicates.
template <class A1, class A2>
result_type | fo.operator() ( A1 a1, A2 a2)
|  | The binary function operator for binary predicates.

Similar function operators are defined for up to 7 arguments.

### Example

The following example defines an efficient and exact version of the orientation predicate over three points using the Cartesian representation with double coordinates and without reference counting (Simple_cartesian<double>::Point_2). Of course, the orientation predicate can already be found in the kernel, but you can follow this example to filter your own predicates. It uses the fast but inexact predicate based on interval arithmetic for filtering and the slow but exact predicate based on multi-precision floats when the filtering predicate fails.

    #include <CGAL/Simple_cartesian.h>
    #include <CGAL/Filtered_predicate.h>
    #include <CGAL/MP_Float.h>
    #include <CGAL/Cartesian_converter.h>

    typedef CGAL::Simple_cartesian<double> K;
    typedef CGAL::Simple_cartesian<CGAL::Interval_nt_advanced> FK;
    typedef CGAL::Simple_cartesian<CGAL::MP_Float> EK;
    typedef CGAL::Cartesian_converter<K, EK> C2E;
    typedef CGAL::Cartesian_converter<K, FK> C2F;

    // Define my predicate, parameterized by a kernel.
    template < typename K >
    struct My_orientation_2
    {
      typedef typename K::RT       RT;
      typedef typename K::Point_2  Point_2;

      CGAL::Orientation
      operator()(const Point_2 &p, const Point_2 &q, const Point_2 &r) const
      {
        RT prx = p.x() - r.x();
        RT pry = p.y() - r.y();
        RT qrx = q.x() - r.x();
        RT qry = q.y() - r.y();
        return static_cast<CGAL::Orientation> ( CGAL::sign( prx*qry - qrx*pqy ) );
      }
    };

    typedef CGAL::Filtered_predicate<My_orientation_2<EK>,
                                     My_orientation_2<FK>, C2E, C2F> Orientation_2;

    int main()
    {
      K::Point_2 p(1,2), q(2,3), r(3,4);
      Orientation_2 orientation;
      orientation(p, q, r);
      return 0;
    }

Next: Homogeneous<RingNumberType>

Navigation: Table of Contents, Bibliography, Index, Title Page

The CGAL Project . Tue, December 21, 2004 .