DecayPairContainerOptimizerState.h

Go to the documentation of this file.

/**
 *  \file IMP/misc/DecayPairContainerOptimizerState.h
 *  \brief Track the particles pairs passed to the pair score.
 *
 *  Copyright 2007-2013 IMP Inventors. All rights reserved.
 */

#ifndef IMPMISC_DECAY_PAIR_CONTAINER_OPTIMIZER_STATE_H
#define IMPMISC_DECAY_PAIR_CONTAINER_OPTIMIZER_STATE_H

#include <IMP/misc/misc_config.h>
#include <IMP/OptimizerState.h>
#include <IMP/PairContainer.h>
#include <IMP/PairContainer.h>
#include <IMP/core/PeriodicOptimizerState.h>
#include <IMP/internal/InternalDynamicListPairContainer.h>
#include <IMP/PairPredicate.h>
#include <IMP/base/Pointer.h>
#include <IMP/optimizer_state_macros.h>

IMPMISC_BEGIN_NAMESPACE

//! Maintain a pair container with a decaying list of pairs.
/** The pair container passed to the constructor provides an initial
    list of pairs. Periodically (see the set_period() method), the
    pedicate is applied to all the remaining pairs and ones for which
    it evaluates to 0 are removed.
 */
class IMPMISCEXPORT DecayPairContainerOptimizerState :
  public core::PeriodicOptimizerState
{
  base::OwnerPointer<PairPredicate> pred_;
  base::OwnerPointer<PairContainer> input_;
  base::Pointer<IMP::internal::InternalDynamicListPairContainer> output_;
 public:
  DecayPairContainerOptimizerState(PairPredicate *pred,
                                   const ParticlePairsTemp &initial_list,
                                   std::string name
                                   ="DecayPairContainerOptimizerState%1%");
  PairContainer *get_output_container() const {
    return output_;
  }
  virtual void do_update(unsigned int call_num) IMP_OVERRIDE;
  IMP_OBJECT_METHODS(DecayPairContainerOptimizerState);
};


IMPMISC_END_NAMESPACE

#endif  /* IMPMISC_DECAY_PAIR_CONTAINER_OPTIMIZER_STATE_H */