triplet_predicates.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-32402/imp-2.19.0/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-32402/imp-2.19.0/tools/build/container_templates/core/classname_predicates.h
// Do not edit - any changes will be lost!

/**
 *  \file IMP/core/triplet_predicates.h
 *  \brief Define some predicates.
 *
 *  Copyright 2007-2023 IMP Inventors. All rights reserved.
 */

#ifndef IMPCORE_TRIPLET_PREDICATES_H
#define IMPCORE_TRIPLET_PREDICATES_H

#include <IMP/core/core_config.h>
#include <IMP/core/Typed.h>
#include <IMP/TripletPredicate.h>
#include <IMP/triplet_macros.h>
#include <boost/random.hpp>
#include "internal/container_helpers.h"
#include <cereal/access.hpp>
#include <cereal/types/base_class.hpp>

IMPCORE_BEGIN_NAMESPACE

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

  friend class cereal::access;
  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<TripletPredicate>(this), v_);
  }
  IMP_OBJECT_SERIALIZE_DECL(ConstantTripletPredicate);

 public:
  ConstantTripletPredicate(int v,
                             std::string name = "ConstTripletPredicate%1%");

  ConstantTripletPredicate() {}

  virtual int get_value_index(Model *, const ParticleIndexTriplet&) const
      override {
    return v_;
  }
  virtual ModelObjectsTemp do_get_inputs(
      Model *, const ParticleIndexes &) const override {
    return ModelObjectsTemp();
  }
  IMP_TRIPLET_PREDICATE_METHODS(ConstantTripletPredicate);
  IMP_OBJECT_METHODS(ConstantTripletPredicate);
};

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

class IMPCOREEXPORT UnorderedTypeTripletPredicate
    : public TripletPredicate {
  friend class cereal::access;
  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<TripletPredicate>(this));
  }
  IMP_OBJECT_SERIALIZE_DECL(UnorderedTypeTripletPredicate);

 public:
  UnorderedTypeTripletPredicate(std::string name =
                                      "UnorderedTypeTripletPredicate%1%");
  virtual int get_value_index(Model *m, const ParticleIndexTriplet& pi) const
      override {
    return internal::get_type_hash(m, pi);
  }
  virtual ModelObjectsTemp do_get_inputs(
      Model *m, const ParticleIndexes &pis) const override {
    ModelObjectsTemp ret;
    ret += IMP::get_particles(m, pis);
    return ret;
  }
  IMP_TRIPLET_PREDICATE_METHODS(UnorderedTypeTripletPredicate);
  IMP_OBJECT_METHODS(UnorderedTypeTripletPredicate);
};

/** Return a unique predicate value for each ordered triplet of
    ParticleTypes (see Typed).
*/
class IMPCOREEXPORT OrderedTypeTripletPredicate : public TripletPredicate {
 private:
  mutable int const* cached_particle_type_ids_table_;
  mutable int cached_n_particle_types_;
 public:
  OrderedTypeTripletPredicate(std::string name =
                                    "OrderedTypeTripletPredicate%1%");
  //! Compute the predicate for specified types
  int get_value(const core::ParticleTypes &types) {
    return internal::get_ordered_type_hash(types);
  }
  //! Compute the predicate for types of specific pi
  virtual int get_value_index(Model *m, const ParticleIndexTriplet& pi) const
      override {
    return internal::get_ordered_type_hash(m, pi);
  }

  //! Setup for a batch of calls to get_value_index_in_batch()
  //! (used for improving performance)
  virtual void setup_for_get_value_index_in_batch(Model* m) const
  override{
    cached_particle_type_ids_table_=
      m->IMP::internal::IntAttributeTable::access_attribute_data(Typed::get_type_key());
    cached_n_particle_types_= ParticleType::get_number_unique();
  };

  //! Same as get_value_index, but with optimizations
  //! for a batch of calls. Call setup_for_get_value_index_in_batch()
  //! right before calling a batch of those, otherwise unexpected behavior.
  virtual int get_value_index_in_batch(Model* m, const ParticleIndexTriplet& pi) const
  override{
    IMP_UNUSED(m);
    return internal::get_ordered_type_hash( pi,
                                            cached_particle_type_ids_table_,
                                            cached_n_particle_types_);
  }

  virtual ModelObjectsTemp do_get_inputs(
      Model *m, const ParticleIndexes &pis) const override {
    ModelObjectsTemp ret;
    ret += IMP::get_particles(m, pis);
    return ret;
  }
  IMP_TRIPLET_PREDICATE_METHODS(OrderedTypeTripletPredicate);
  IMP_OBJECT_METHODS(OrderedTypeTripletPredicate);
};

/** Return true if all members of the tuple are the same. */
class IMPCOREEXPORT AllSameTripletPredicate : public TripletPredicate {
  friend class cereal::access;
  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<TripletPredicate>(this));
  }
  IMP_OBJECT_SERIALIZE_DECL(AllSameTripletPredicate);

 public:
  AllSameTripletPredicate(std::string name = "AllSameTripletPredicate%1%");
  virtual int get_value_index(Model *m, const ParticleIndexTriplet& pi) const
      override {
    return internal::get_all_same(m, pi);
  }
  virtual ModelObjectsTemp do_get_inputs(
      Model *, const ParticleIndexes &) const override {
    return ModelObjectsTemp();
  }
  IMP_TRIPLET_PREDICATE_METHODS(AllSameTripletPredicate);
  IMP_OBJECT_METHODS(AllSameTripletPredicate);
};

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

 public:
  CoinFlipTripletPredicate(double p, std::string name =
                                           "CoinFlipTripletPredicate%1%");
  virtual int get_value_index(Model *, const ParticleIndexTriplet&) const
      override {
    if (rng_(random_number_generator) < p_)
      return 1;
    else
      return 0;
  }
  virtual ModelObjectsTemp do_get_inputs(
      Model *, const ParticleIndexes &) const override {
    return ModelObjectsTemp();
  }
  IMP_TRIPLET_PREDICATE_METHODS(CoinFlipTripletPredicate);
  IMP_OBJECT_METHODS(CoinFlipTripletPredicate);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_TRIPLET_PREDICATES_H */