view.hpp

Go to the documentation of this file.

/* -*- mode: C++; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
 *  Main authors:
 *     Christian Schulte <schulte@gecode.org>
 *     Vincent Barichard <Vincent.Barichard@univ-angers.fr>
 *
 *  Copyright:
 *     Christian Schulte, 2005
 *     Vincent Barichard, 2012
 *
 *  This file is part of Gecode, the generic constraint
 *  development environment:
 *     http://www.gecode.org
 *
 *  Permission is hereby granted, free of charge, to any person obtaining
 *  a copy of this software and associated documentation files (the
 *  "Software"), to deal in the Software without restriction, including
 *  without limitation the rights to use, copy, modify, merge, publish,
 *  distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so, subject to
 *  the following conditions:
 *
 *  The above copyright notice and this permission notice shall be
 *  included in all copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#include <iostream>

namespace Gecode { namespace Float {

  class FloatView : public VarImpView<FloatVar> {
  protected:
    using VarImpView<FloatVar>::x;
  public:


    FloatView(void);
    FloatView(const FloatVar& y);
    FloatView(FloatVarImp* y);



    FloatVal domain(void) const;
    FloatNum min(void) const;
    FloatNum max(void) const;
    FloatNum med(void) const;
    FloatVal val(void) const;

    FloatNum size(void) const;



    bool zero_in(void) const;
    bool in(FloatNum n) const;
    bool in(const FloatVal& n) const;



    ModEvent lq(Space& home, int n);
    ModEvent lq(Space& home, FloatNum n);
    ModEvent lq(Space& home, FloatVal n);

    ModEvent gq(Space& home, int n);
    ModEvent gq(Space& home, FloatNum n);
    ModEvent gq(Space& home, FloatVal n);

    ModEvent eq(Space& home, int n);
    ModEvent eq(Space& home, FloatNum n);
    ModEvent eq(Space& home, const FloatVal& n);




    FloatNum min(const Delta& d) const;
    FloatNum max(const Delta& d) const;



    static ModEventDelta med(ModEvent me);
  };

  template<class Char, class Traits>
  std::basic_ostream<Char,Traits>&
  operator <<(std::basic_ostream<Char,Traits>& os, const FloatView& x);

  class MinusView : public DerivedView<FloatView> {
  protected:
    using DerivedView<FloatView>::x;
  public:


    MinusView(void);
    explicit MinusView(const FloatView& y);



    FloatVal domain(void) const;
    FloatNum min(void) const;
    FloatNum max(void) const;
    FloatNum med(void) const;
    FloatVal val(void) const;

    FloatNum size(void) const;



    bool zero_in(void) const;
    bool in(FloatNum n) const;
    bool in(const FloatVal& n) const;



    ModEvent lq(Space& home, int n);
    ModEvent lq(Space& home, FloatNum n);
    ModEvent lq(Space& home, FloatVal n);

    ModEvent gq(Space& home, int n);
    ModEvent gq(Space& home, FloatNum n);
    ModEvent gq(Space& home, FloatVal n);

    ModEvent eq(Space& home, int n);
    ModEvent eq(Space& home, FloatNum n);
    ModEvent eq(Space& home, const FloatVal& n);




    FloatNum min(const Delta& d) const;
    FloatNum max(const Delta& d) const;



    static ModEventDelta med(ModEvent me);
  };

  template<class Char, class Traits>
  std::basic_ostream<Char,Traits>&
  operator <<(std::basic_ostream<Char,Traits>& os, const MinusView& x);


  class OffsetView : public DerivedView<FloatView> {
  protected:
    FloatNum c;
    using DerivedView<FloatView>::x;
  public:


    OffsetView(void);
    explicit OffsetView(const FloatView& y, FloatNum c);



    FloatNum offset(void) const;
    void offset(FloatNum n);
    FloatVal domain(void) const;
    FloatNum min(void) const;
    FloatNum max(void) const;
    FloatNum med(void) const;
    FloatVal val(void) const;

    FloatNum size(void) const;



    bool zero_in(void) const;
    bool in(FloatNum n) const;
    bool in(const FloatVal& n) const;



    ModEvent lq(Space& home, int n);
    ModEvent lq(Space& home, FloatNum n);
    ModEvent lq(Space& home, FloatVal n);

    ModEvent gq(Space& home, int n);
    ModEvent gq(Space& home, FloatNum n);
    ModEvent gq(Space& home, FloatVal n);

    ModEvent eq(Space& home, int n);
    ModEvent eq(Space& home, FloatNum n);
    ModEvent eq(Space& home, const FloatVal& n);




    FloatNum min(const Delta& d) const;
    FloatNum max(const Delta& d) const;



    static ModEventDelta med(ModEvent me);


    void update(Space& home, OffsetView& y);
  };

  template<class Char, class Traits>
  std::basic_ostream<Char,Traits>&
  operator <<(std::basic_ostream<Char,Traits>& os, const OffsetView& x);

  class ScaleView : public DerivedView<FloatView> {
  protected:
    using DerivedView<FloatView>::x;
    FloatVal a;

  public:


    ScaleView(void);
    ScaleView(FloatVal b, const FloatView& y);



    FloatVal domain(void) const;
    FloatVal scale(void) const;
    FloatNum min(void) const;
    FloatNum max(void) const;
    FloatNum med(void) const;

    FloatVal val(void) const;

    FloatNum size(void) const;



    bool zero_in(void) const;
    bool in(FloatNum n) const;
    bool in(const FloatVal& n) const;



    ModEvent lq(Space& home, int n);
    ModEvent lq(Space& home, FloatNum n);
    ModEvent lq(Space& home, FloatVal n);

    ModEvent gq(Space& home, int n);
    ModEvent gq(Space& home, FloatNum n);
    ModEvent gq(Space& home, FloatVal n);

    ModEvent eq(Space& home, int n);
    ModEvent eq(Space& home, FloatNum n);
    ModEvent eq(Space& home, const FloatVal& n);




    FloatNum min(const Delta& d) const;
    FloatNum max(const Delta& d) const;



    static ModEventDelta med(ModEvent me);


    void update(Space& home, ScaleView& y);
  };

  template<class Char, class Traits>
  std::basic_ostream<Char,Traits>&
  operator <<(std::basic_ostream<Char,Traits>& os, const ScaleView& x);

} }

#include <gecode/float/var/float.hpp>
#include <gecode/float/view/float.hpp>
#include <gecode/float/view/minus.hpp>
#include <gecode/float/view/offset.hpp>
#include <gecode/float/view/scale.hpp>
#include <gecode/float/view/print.hpp>
#include <gecode/float/var/print.hpp>

namespace Gecode { namespace Float {

  enum RelTest {
    RT_FALSE = 0, 
    RT_MAYBE = 1, 
    RT_TRUE  = 2  
  };

  template<class View> RelTest rtest_eq(View x, View y);
  template<class View> RelTest rtest_eq(View x, FloatVal n);

  template<class View> RelTest rtest_lq(View x, View y);
  template<class View> RelTest rtest_lq(View x, FloatVal n);

  template<class View> RelTest rtest_le(View x, View y);
  template<class View> RelTest rtest_le(View x, FloatVal n);


}}

#include <gecode/float/view/rel-test.hpp>

// STATISTICS: float-var