TwelveANeighborGraph.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   core/scoring/TwelveANeighborGraph.hh
/// @brief  Twelve Angstrom Neighbor Graph class declaration
/// @author Andrew Leaver-Fay (leaverfa@email.unc.edu)

#ifndef INCLUDED_core_scoring_TwelveANeighborGraph_hh
#define INCLUDED_core_scoring_TwelveANeighborGraph_hh

// Unit Headers
#include <core/scoring/TwelveANeighborGraph.fwd.hh>

// Package Headers
#include <core/scoring/ContextGraph.hh>

// Project Headers
#include <core/graph/Graph.hh>
#include <core/pose/Pose.fwd.hh>

#include <utility/vector1.hh>



namespace core {
namespace scoring {

class TwelveANeighborNode : public graph::Node
{
public:
  typedef graph::Node parent;

public:
  virtual ~TwelveANeighborNode();
  TwelveANeighborNode( graph::Graph*, Size node_id );

  virtual void copy_from( Node const * source );

  virtual Size count_static_memory() const;
  virtual Size count_dynamic_memory() const;
private:

};

class TwelveANeighborEdge : public graph::Edge
{
public:
  typedef graph::Edge parent;

public:
  virtual ~TwelveANeighborEdge();
  TwelveANeighborEdge(graph::Graph* owner, Size first_node_ind, Size second_node_ind);

  virtual void copy_from( graph::Edge const * source );

  virtual Size count_static_memory() const;
  virtual Size count_dynamic_memory() const;

private:

};

class TwelveANeighborGraph : public ContextGraph
{
public:
  typedef ContextGraph parent;

public:

  virtual ~TwelveANeighborGraph();

  TwelveANeighborGraph();
  TwelveANeighborGraph(Size num_nodes);
  TwelveANeighborGraph( TwelveANeighborGraph const & source );
  TwelveANeighborGraph & operator = ( TwelveANeighborGraph const & source );

  virtual
  Distance
  neighbor_cutoff() const;

  virtual
  void
  conditionally_add_edge(
    Size lower_node_id,
    Size upper_node_id,
    DistanceSquared dsq
  );

  virtual
  ContextGraphOP
  clone() const;

  virtual
  void update_from_pose(
    pose::Pose const & pose
  );

  virtual void delete_edge( graph::Edge * edge );

protected:

  virtual Size count_static_memory() const;
  virtual Size count_dynamic_memory() const;

  virtual graph::Node * create_new_node( Size node_index );
  virtual graph::Edge * create_new_edge( Size index1, Size index2);
  virtual graph::Edge * create_new_edge( graph::Edge const * example_edge );

private:
  static Distance const twelveA_;
  static DistanceSquared const twelveA_squared_;

};

} // scoring
} // core

#endif