quad_predicates.h

Go to the documentation of this file.

/**
 *  \file IMP/core/quad_predicates.h
 *  \brief Define some predicates.
 *
 *  WARNING This file was generated from quad_predicates.h
 *  in /tmp/nightly-build-90828/imp-2.2.1/tools/build/container_templates/core
 *  by tools/maintenance/setup_containers.py.
 *
 *  Copyright 2007-2014 IMP Inventors. All rights reserved.
 */

#ifndef IMPCORE_QUAD_PREDICATES_H
#define IMPCORE_QUAD_PREDICATES_H

#include <IMP/core/core_config.h>
#include <IMP/QuadPredicate.h>
#include <IMP/quad_macros.h>
#include <boost/random.hpp>
#include "internal/container_helpers.h"

IMPCORE_BEGIN_NAMESPACE

/** Always return a constant value.
 */
class IMPCOREEXPORT ConstantQuadPredicate : public QuadPredicate {
  int v_;

 public:
  ConstantQuadPredicate(int v,
                             std::string name = "ConstQuadPredicate%1%");
  virtual int get_value_index(kernel::Model *, const kernel::ParticleIndexQuad&) const
      IMP_OVERRIDE {
    return v_;
  }
  virtual kernel::ModelObjectsTemp do_get_inputs(
      kernel::Model *, const kernel::ParticleIndexes &) const IMP_OVERRIDE {
    return kernel::ModelObjectsTemp();
  }
  IMP_QUAD_PREDICATE_METHODS(ConstantQuadPredicate);
  IMP_OBJECT_METHODS(ConstantQuadPredicate);
};

/** Return a unique predicate value for each unordered set of
   kernel::ParticleTypes
    (see Typed).
*/

class IMPCOREEXPORT UnorderedTypeQuadPredicate
    : public QuadPredicate {
 public:
  UnorderedTypeQuadPredicate(std::string name =
                                      "UnorderedTypeQuadPredicate%1%");
  virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexQuad& pi) const
      IMP_OVERRIDE {
    return internal::get_type_hash(m, pi);
  }
  virtual kernel::ModelObjectsTemp do_get_inputs(
      kernel::Model *m, const kernel::ParticleIndexes &pis) const IMP_OVERRIDE {
    kernel::ModelObjectsTemp ret;
    ret += IMP::get_particles(m, pis);
    return ret;
  }
  IMP_QUAD_PREDICATE_METHODS(UnorderedTypeQuadPredicate);
  IMP_OBJECT_METHODS(UnorderedTypeQuadPredicate);
};

/** Return a unique predicate value for each ordered quad of
    kernel::ParticleTypes (see Typed).
*/
class IMPCOREEXPORT OrderedTypeQuadPredicate : public QuadPredicate {
 public:
  OrderedTypeQuadPredicate(std::string name =
                                    "OrderedTypeQuadPredicate%1%");
#ifndef SWIG
  using QuadPredicate::get_value;
#endif
  int get_value(const core::ParticleTypes &types) {
    return internal::get_ordered_type_hash(types);
  }
  virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexQuad& pi) const
      IMP_OVERRIDE {
    return internal::get_ordered_type_hash(m, pi);
  }
  virtual kernel::ModelObjectsTemp do_get_inputs(
      kernel::Model *m, const kernel::ParticleIndexes &pis) const IMP_OVERRIDE {
    kernel::ModelObjectsTemp ret;
    ret += IMP::get_particles(m, pis);
    return ret;
  }
  IMP_QUAD_PREDICATE_METHODS(OrderedTypeQuadPredicate);
  IMP_OBJECT_METHODS(OrderedTypeQuadPredicate);
};

/** Return true if all members of the tuple are the same. */
class IMPCOREEXPORT AllSameQuadPredicate : public QuadPredicate {
 public:
  AllSameQuadPredicate(std::string name = "AllSameQuadPredicate%1%");
  virtual int get_value_index(kernel::Model *m, const kernel::ParticleIndexQuad& pi) const
      IMP_OVERRIDE {
    return internal::get_all_same(m, pi);
  }
  virtual kernel::ModelObjectsTemp do_get_inputs(
      kernel::Model *, const kernel::ParticleIndexes &) const IMP_OVERRIDE {
    return kernel::ModelObjectsTemp();
  }
  IMP_QUAD_PREDICATE_METHODS(AllSameQuadPredicate);
  IMP_OBJECT_METHODS(AllSameQuadPredicate);
};

/** Return true with a fixed probability. */
class IMPCOREEXPORT CoinFlipQuadPredicate : public QuadPredicate {
  double p_;
  mutable boost::uniform_real<double> rng_;

 public:
  CoinFlipQuadPredicate(double p, std::string name =
                                           "CoinFlipQuadPredicate%1%");
  virtual int get_value_index(kernel::Model *, const kernel::ParticleIndexQuad&) const
      IMP_OVERRIDE {
    if (rng_(base::random_number_generator) < p_)
      return 1;
    else
      return 0;
  }
  virtual kernel::ModelObjectsTemp do_get_inputs(
      kernel::Model *, const kernel::ParticleIndexes &) const IMP_OVERRIDE {
    return kernel::ModelObjectsTemp();
  }
  IMP_QUAD_PREDICATE_METHODS(CoinFlipQuadPredicate);
  IMP_OBJECT_METHODS(CoinFlipQuadPredicate);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_QUAD_PREDICATES_H */