Mover.h

Go to the documentation of this file.

/**
 *  \file IMP/core/Mover.h
 *  \brief Backwards compatibility.
 *
 *  Copyright 2007-2013 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPCORE_MOVER_H
#define IMPCORE_MOVER_H

#include <IMP/core/core_config.h>
#include "MonteCarloMover.h"
#include <IMP/kernel/Model.h>
#include <IMP/kernel/Particle.h>

IMPCORE_DEPRECATED_HEADER(2.1, "Use MonteCarloMover");

IMPCORE_BEGIN_NAMESPACE

/** \deprecated_at{2.1} Use MonteCarloMover instead
 */
class IMPCOREEXPORT Mover : public MonteCarloMover {
 public:
  IMPCORE_DEPRECATED_OBJECT_DECL(2.1)
  Mover(kernel::Model *m, std::string name) : MonteCarloMover(m, name) {
    IMPCORE_DEPRECATED_OBJECT_DEF(2.1, "Use MonteCarloMover");
  }

  virtual kernel::ParticlesTemp propose_move(Float size) = 0;

  //! Roll back any changes made to the kernel::Particles
  virtual void reset_move() = 0;

  //! Return the set of particles over which moves can be proposed
  virtual kernel::ParticlesTemp get_output_particles() const = 0;

 protected:
  virtual kernel::ModelObjectsTemp do_get_inputs() const IMP_OVERRIDE {
    return get_as<ModelObjectsTemp>(get_output_particles());
  }
  virtual MonteCarloMoverResult do_propose() IMP_OVERRIDE {
    return MonteCarloMoverResult(get_indexes(propose_move(1.0)), 1.0);
  }
  virtual void do_reject() IMP_OVERRIDE { reset_move(); }
};

typedef MonteCarloMovers Movers;
typedef MonteCarloMoversTemp MoversTemp;

IMPCORE_END_NAMESPACE

#endif /* IMPCORE_MOVER_H */