pair_predicates.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-465/imp-20241221.develop.63b38c487d/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-465/imp-20241221.develop.63b38c487d/tools/build/container_templates/core/classname_predicates.h
// Do not edit - any changes will be lost!

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

#ifndef IMPCORE_PAIR_PREDICATES_H
#define IMPCORE_PAIR_PREDICATES_H

#include <IMP/core/core_config.h>
#include <IMP/core/Typed.h>
#include <IMP/PairPredicate.h>
#include <IMP/pair_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 ConstantPairPredicate : public PairPredicate {
  int v_;

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

 public:
  ConstantPairPredicate(int v,
                             std::string name = "ConstPairPredicate%1%");

  ConstantPairPredicate() {}

  virtual int get_value_index(Model *, const ParticleIndexPair&) const
      override {
    return v_;
  }
  virtual ModelObjectsTemp do_get_inputs(
      Model *, const ParticleIndexes &) const override {
    return ModelObjectsTemp();
  }
  IMP_PAIR_PREDICATE_METHODS(ConstantPairPredicate);
  IMP_OBJECT_METHODS(ConstantPairPredicate);
};

//! Return a unique predicate value for each unordered set of ParticleTypes
/** When applied to a set of particles that are decorated with the
    Typed decorator, this returns a value that is a function of all of
    the types. The order of the particles does not matter.
 */
class IMPCOREEXPORT UnorderedTypePairPredicate
    : public PairPredicate {
  friend class cereal::access;
  template<class Archive> void serialize(Archive &ar) {
    ar(cereal::base_class<PairPredicate>(this));
  }
  IMP_OBJECT_SERIALIZE_DECL(UnorderedTypePairPredicate);

 public:
  UnorderedTypePairPredicate(std::string name =
                                      "UnorderedTypePairPredicate%1%");
  virtual int get_value_index(Model *m, const ParticleIndexPair& 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_PAIR_PREDICATE_METHODS(UnorderedTypePairPredicate);
  IMP_OBJECT_METHODS(UnorderedTypePairPredicate);
};

//! Return a unique predicate value for each ordered set of ParticleTypes
/** When applied to a set of particles that are decorated with the
    Typed decorator, this returns a value that is a function of all of
    the types. The order of the particles matters.
 */
class IMPCOREEXPORT OrderedTypePairPredicate : public PairPredicate {
 private:
  mutable int const* cached_particle_type_ids_table_;
  mutable int cached_n_particle_types_;
 public:
  OrderedTypePairPredicate(std::string name =
                                    "OrderedTypePairPredicate%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 ParticleIndexPair& 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 ParticleIndexPair& 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_PAIR_PREDICATE_METHODS(OrderedTypePairPredicate);
  IMP_OBJECT_METHODS(OrderedTypePairPredicate);
};

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

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

//! Return true (1) with a fixed probability.
class IMPCOREEXPORT CoinFlipPairPredicate : public PairPredicate {
  double p_;
  mutable boost::random::uniform_real_distribution<double> rng_;

 public:
  CoinFlipPairPredicate(double p, std::string name =
                                           "CoinFlipPairPredicate%1%");
  virtual int get_value_index(Model *, const ParticleIndexPair&) 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_PAIR_PREDICATE_METHODS(CoinFlipPairPredicate);
  IMP_OBJECT_METHODS(CoinFlipPairPredicate);
};

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_PAIR_PREDICATES_H */