SidechainMetropolisHastingsMover.hh

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file /protocols/canonical_sampling/MetropolisHastingsMover.hh
/// @brief
/// @author

#ifndef INCLUDED_protocols_canonical_sampling_SidechainMetropolisHastingsMover_hh
#define INCLUDED_protocols_canonical_sampling_SidechainMetropolisHastingsMover_hh

// Unit Headers
#include <protocols/canonical_sampling/SidechainMetropolisHastingsMover.fwd.hh>
#include <protocols/canonical_sampling/MetropolisHastingsMover.hh>
#include <protocols/moves/Mover.hh>

// Project Headers
#include <protocols/moves/MonteCarlo.fwd.hh>
#include <protocols/canonical_sampling/ThermodynamicMover.hh>
#include <protocols/canonical_sampling/ThermodynamicObserver.hh>
#include <core/pose/Pose.fwd.hh>
#include <numeric/random/WeightedSampler.hh>

// Utility Headers
#include <core/types.hh>
#include <utility/vector1.hh>

namespace protocols {
namespace canonical_sampling {

///@details
class SidechainMetropolisHastingsMover : public protocols::canonical_sampling::MetropolisHastingsMover {

public:
  typedef MetropolisHastingsMover Parent;

  SidechainMetropolisHastingsMover();

  SidechainMetropolisHastingsMover( core::Size stride );

  SidechainMetropolisHastingsMover(
    SidechainMetropolisHastingsMover const & metropolis_hastings_mover
  );

  virtual
  ~SidechainMetropolisHastingsMover();

  virtual
  void
  apply( core::pose::Pose & pose );

  virtual
  std::string
  get_name() const;

  protocols::moves::MoverOP
  clone() const;

  virtual
  protocols::moves::MoverOP
  fresh_instance() const;

  virtual
  void
  parse_my_tag(
    utility::tag::TagPtr const tag,
    protocols::moves::DataMap & data,
    protocols::filters::Filters_map const & filters,
    protocols::moves::Movers_map const & movers,
    core::pose::Pose const & pose
  );

  bool pass_metropolis( core::Real delta_energy , core::Real last_proposal_density_ratio ) const;

  core::Size output_count( core::Size ct ) const;

  void set_stride( core::Size setting ) { stride_ = setting; };

private:
  core::Size stride_;
}; //end SidechainMetropolisHastingsMover

} //namespace canonical_sampling
} //namespace protocols

#endif //INCLUDED_protocols_canonical_sampling_SidechainMetropolisHastingsMover_HH