PairModifier.h

Go to the documentation of this file.

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

/**
 *  \file IMP/PairModifier.h
 *  \brief A Modifier on ParticlePairsTemp
 *
 *  Copyright 2007-2022 IMP Inventors. All rights reserved.
 */

#ifndef IMPKERNEL_PAIR_MODIFIER_H
#define IMPKERNEL_PAIR_MODIFIER_H

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

IMPKERNEL_BEGIN_NAMESPACE

//! A base class for modifiers of ParticlePairsTemp
/** The primary function of such a class is to change
    the passed particles.

    \see IMP::PairPredicate

    Implementers should see IMP_PAIR_MODIFIER(). Also see
    PairDerivativeModifier.
 */
class IMPKERNELEXPORT PairModifier : public ParticleInputs,
                                          public ParticleOutputs,
                                          public Object {
 public:
  typedef ParticlePair Argument;
  typedef ParticleIndexPair IndexArgument;
  PairModifier(std::string name = "PairModifier %1%");

  /** Apply the function to a single value*/
  virtual void apply_index(Model *m, const ParticleIndexPair& v) const = 0;

  /** Apply the function to a collection of ParticlePairsTemp */
  /** If bounds are passed, only apply to ones between the upper and
      lower bounds.*/
  virtual void apply_indexes(Model *m, const ParticleIndexPairs &o,
                             unsigned int lower_bound,
                             unsigned int upper_bound) const {
    for (unsigned int i = lower_bound; i < upper_bound; ++i) {
      apply_index(m, o[i]);
    }
  }

  /** Apply the function to a collection of ParticlePairsTemp */
  /** Information on particles that moved since the last scoring function
      evaluation is also passed, which may be used to accelerate the
      computation. */
  virtual void apply_indexes_moved(
              Model *m, const ParticleIndexPairs &o,
              unsigned int lower_bound, unsigned int upper_bound,
              const ParticleIndexes &moved_pis,
              const ParticleIndexes &reset_pis) const {
    IMP_UNUSED(moved_pis);
    IMP_UNUSED(reset_pis);
    apply_indexes(m, o, lower_bound, upper_bound);
  }
};

IMPKERNEL_END_NAMESPACE

#endif /* IMPKERNEL_PAIR_MODIFIER_H */