DistancePairConstraint.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 src/core/scoring/DistancePairConstraint.hh
/// @brief Restrain a pair of residues to take the same torsion angles
/// @author Frank DiMaio, Fabio Parmeggiani

#ifndef INCLUDED_core_scoring_constraints_DistancePairConstraint_hh
#define INCLUDED_core_scoring_constraints_DistancePairConstraint_hh

#include <core/scoring/constraints/Constraint.hh>
#include <core/scoring/constraints/Func.fwd.hh>
#include <core/scoring/constraints/XYZ_Func.fwd.hh>
#include <core/scoring/EnergyMap.fwd.hh>

#include <core/scoring/ScoreType.hh>
#include <core/id/AtomID.hh>

#include <string>

#include <utility/vector1.hh>


namespace core {
namespace scoring {
namespace constraints {


/// constraint on CA distance

class DistancePairConstraint : public Constraint {
public:

  virtual std::string type() const {
    return "DistancePair";
  }

  virtual ConstraintOP clone() const {
    return new DistancePairConstraint(
      atomA1_, atomA2_,
      atomB1_, atomB2_,
      func_, score_type()
    );
  }

  Size show_violations( std::ostream& out, pose::Pose const& pose, Size verbose_level, Real threshold = 1 ) const;

  void read_def(
    std::istream & in,
    pose::Pose const & pose,
    FuncFactory const & func_factory
  );

  /// @brief possibility to compare constraint according to data
  /// and not just pointers
  bool operator == ( Constraint const & other ) const;

  Real
  score(
    Vector const & X1, Vector const & X2,
    Vector const & Y1, Vector const & Y2
  ) const;

  void
  score( XYZ_Func const & xyz, EnergyMap const &, EnergyMap & emap ) const;

  Real
  score( conformation::Conformation const & conformation  ) const;

  // atom deriv
  void
  fill_f1_f2(
    AtomID const & atom,
    XYZ_Func const & xyz,
    Vector & F1, Vector & F2,
    EnergyMap const & weights
  ) const;

  ///c-tor
  DistancePairConstraint(
    AtomID const & a1, AtomID const & a2,
    AtomID const & b1, AtomID const & b2,
    FuncOP func,
    ScoreType scotype = atom_pair_constraint
  ):
    Constraint( scotype ),
    atomA1_(a1), atomA2_(a2),
    atomB1_(b1), atomB2_(b2),
    func_( func )
  {}

  Size
  natoms() const {
    return 4;
  }

  virtual
  ConstraintOP
  remap_resid( core::id::SequenceMapping const & seqmap ) const;

  AtomID const &
  atom( Size const n ) const;

  virtual void show( std::ostream & out ) const;

  // Coppied Remapped_clone from AtomPairConstraint
  /// @brief Copies the data from this Constraint into a new object and returns an OP
  /// atoms are mapped to atoms with the same name in dest pose ( e.g. for switch from centroid to fullatom )
  /// if a sequence_mapping is present it is used to map residue numbers .. NULL = identity mapping
  /// to the new object. Intended to be implemented by derived classes.
  virtual ConstraintOP remapped_clone(
    pose::Pose const & src,
    pose::Pose const & dest,
    id::SequenceMappingCOP map = NULL
  ) const;

private:
  Real
  func( Real const theta ) const;

  Real
  dfunc( Real const theta ) const;


private:
  // data
  AtomID atomA1_, atomA2_;
  AtomID atomB1_, atomB2_;
  FuncOP func_;
};

} // constraints
} // scoring
} // core

#endif