PairPredicate.h

Go to the documentation of this file.

// Autogenerated by ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/make_containers.py
// from ../../../../tmp/nightly-build-16408/imp-2.14.0/tools/build/container_templates/kernel/ClassnamePredicate.h
// Do not edit - any changes will be lost!

/**
 *  \file IMP/PairPredicate.h
 *  \brief Define PairPredicate.
 *
 *  Copyright 2007-2020 IMP Inventors. All rights reserved.
 */

#ifndef IMPKERNEL_PAIR_PREDICATE_H
#define IMPKERNEL_PAIR_PREDICATE_H

#include <IMP/kernel_config.h>
#include "base_types.h"
#include "DerivativeAccumulator.h"
#include "internal/container_helpers.h"
#include "model_object_helpers.h"

IMPKERNEL_BEGIN_NAMESPACE

//! Abstract predicate function
/** A predicate is a function which returns one of a discrete set of
    values (eg -1, 0, 1 depending on whether a value is negative, zero
    or positive). PairPredicates will evaluate the predicate for the passed
    particles.

    Implementers should check out IMP_PAIR_PREDICATE().
*/
class IMPKERNELEXPORT PairPredicate : public ParticleInputs,
                                           public Object {
 public:
  typedef ParticlePair Argument;
  typedef ParticleIndexPair IndexArgument;
  PairPredicate(std::string name = "PairPredicate %1%");
  /** \deprecated_at{2.1} Use the index based version.*/
  IMPKERNEL_DEPRECATED_METHOD_DECL(2.1)
  virtual int get_value(const ParticlePair& vt) const;

  /** \deprecated_at{2.1} Use the index based version.*/
  IMPKERNEL_DEPRECATED_METHOD_DECL(2.1)
  virtual Ints get_value(const ParticlePairsTemp &o) const;

#if !defined(IMP_DOXYGEN) && !defined(SWIG)
  //! remove any particles in ps for which this predicate evaluates to v
  virtual void remove_if_equal(Model *m, ParticleIndexPairs &ps,
                               int v) const;
  //! remove any particles in ps for which this predicate does not evaluate to v
  virtual void remove_if_not_equal(Model *m, ParticleIndexPairs &ps,
                                   int v) const;
#endif

  //! Compute the predicate and the derivative if needed.
  virtual int get_value_index(Model *m, const ParticleIndexPair& vt) const;

  //! Setup for a batch of calls to get_value_index_in_batch()
  //! (could be used for improving performance - e.g. preload various
  //!  tables from model)
  virtual void setup_for_get_value_index_in_batch(Model*) const {};

  //! Same as get_value_index, but possibly with optimizations
  //! for a batch of calls. Call setup_for_get_value_index_in_batch()
  //! right before calling a batch of those.
  virtual int get_value_index_in_batch(Model* m, const ParticleIndexPair& vt) const{
    return get_value_index(m, vt);
  }

  //! Enable them to be use as functors
  /** But beware of slicing.
   */
  int operator()(Model *m, const ParticleIndexPair& vt) const {
    return get_value_index(m, vt);
  }

  virtual Ints get_value_index(Model *m,
                               const ParticleIndexPairs &o) const {
    Ints ret(o.size());
    for (unsigned int i = 0; i < o.size(); ++i) {
      ret[i] += get_value_index(m, o[i]);
    }
    return ret;
  }

  IMP_REF_COUNTED_DESTRUCTOR(PairPredicate);
};

IMPKERNEL_END_NAMESPACE

#endif /* IMPKERNEL_PAIR_PREDICATE_H */