val.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>
*
* Copyright:
* Christian Schulte, 2008
*
* 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.
*
*/
namespace Gecode {
template<class Var>
class ValBranch {
public:
typedef typename BranchTraits<Var>::Val BranchVal;
typedef typename BranchTraits<Var>::Commit BranchCommit;
protected:
Rnd r;
BranchVal vf;
BranchCommit cf;
public:
ValBranch(void);
ValBranch(Rnd r);
ValBranch(BranchVal v, BranchCommit c);
Rnd rnd(void) const;
BranchVal val(void) const;
BranchCommit commit(void) const;
};
template<class Var>
inline
ValBranch<Var>::ValBranch(void)
: vf(nullptr), cf(nullptr) {}
template<class Var>
inline
ValBranch<Var>::ValBranch(Rnd r0)
: r(r0), vf(nullptr), cf(nullptr) {
if (!r)
throw UninitializedRnd("ValBranch::ValBranch");
}
template<class Var>
inline
ValBranch<Var>::ValBranch(BranchVal v, BranchCommit c)
: vf(v), cf(c) {}
template<class Var>
inline Rnd
ValBranch<Var>::rnd(void) const {
return r;
}
template<class Var>
inline typename ValBranch<Var>::BranchVal
ValBranch<Var>::val(void) const {
return vf;
}
template<class Var>
inline typename ValBranch<Var>::BranchCommit
ValBranch<Var>::commit(void) const {
return cf;
}
}
// STATISTICS: kernel-branch
Gecode::BranchTraits
Traits for branching.
Definition traits.hpp:55
Gecode::Rnd
Random number generator.
Definition rnd.hpp:42
Gecode::UninitializedRnd
Exception: uninitialized random number generator
Definition exception.hpp:142
Gecode::ValBranch::cf
BranchCommit cf
Commit function.
Definition val.hpp:53
Gecode::ValBranch::rnd
Rnd rnd(void) const
Return random number generator.
Definition val.hpp:90
Gecode::ValBranch::commit
BranchCommit commit(void) const
Return commit function.
Definition val.hpp:102
Gecode::ValBranch::val
BranchVal val(void) const
Return value function.
Definition val.hpp:96
Gecode::ValBranch::ValBranch
ValBranch(void)
Initialize.
Definition val.hpp:72
Gecode::ValBranch::BranchCommit
BranchTraits< Var >::Commit BranchCommit
The corresponding branching commit function.
Definition val.hpp:46
Gecode::ValBranch::r
Rnd r
Random number generator.
Definition val.hpp:49
Gecode::ValBranch::vf
BranchVal vf
Value function.
Definition val.hpp:51
Gecode::ValBranch::BranchVal
BranchTraits< Var >::Val BranchVal
The corresponding branching value function.
Definition val.hpp:44
Gecode
Gecode toplevel namespace