Rosetta  2020.46
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Private Attributes | List of all members
protocols::genetic_algorithm::Entity Class Reference

#include <Entity.hh>

Inheritance diagram for protocols::genetic_algorithm::Entity:
Inheritance graph
[legend]

Public Types

typedef
utility::pointer::shared_ptr
< Entity
OP
 
typedef
utility::pointer::shared_ptr
< Entity const > 
COP
 
typedef
utility::pointer::weak_ptr
< Entity const > 
CAP
 
typedef utility::vector1< COPCOPs
 
typedef utility::vector1< CAPCAPs
 

Public Member Functions

 Entity ()
 
 Entity (Entity const &entity)
 
Entityoperator= (Entity const &)
 
 ~Entity () override
 
 Entity (std::string const &line)
 construct Entity from std::string (e.g. from file) More...
 
virtual OP clone () const
 
virtual void set_traits_size (core::Size size)
 
virtual void set_traits (EntityElements const &traits)
 
virtual EntityElements const & traits () const
 
virtual void set_entity_element (core::Size index, EntityElementOP element)
 
virtual void set_fitness (core::Real val)
 
virtual core::Real fitness () const
 
virtual bool fitness_valid () const
 
virtual bool operator== (Entity const &other) const
 
virtual bool operator< (Entity const &other) const
 
virtual void show (std::ostream &os) const
 
virtual std::string to_string () const
 
virtual std::string traits_string () const
 
virtual void write_checkpoint (std::ostream &os) const
 
virtual bool read_checkpoint (std::istream &is)
 

Private Attributes

EntityElements traits_
 
core::Real fitness_
 
bool fitness_valid_
 

Detailed Description

Entity: a vector of EntityElements used to describe the state for a system under optimization.

Member Typedef Documentation

typedef utility::pointer::weak_ptr< Entity const > protocols::genetic_algorithm::Entity::CAP
typedef utility::vector1< CAP > protocols::genetic_algorithm::Entity::CAPs
typedef utility::pointer::shared_ptr< Entity const > protocols::genetic_algorithm::Entity::COP
typedef utility::vector1< COP > protocols::genetic_algorithm::Entity::COPs
typedef utility::pointer::shared_ptr< Entity > protocols::genetic_algorithm::Entity::OP

Constructor & Destructor Documentation

protocols::genetic_algorithm::Entity::Entity ( )
protocols::genetic_algorithm::Entity::Entity ( Entity const &  entity)

References traits_.

protocols::genetic_algorithm::Entity::~Entity ( )
overridedefault
protocols::genetic_algorithm::Entity::Entity ( std::string const &  line)

construct Entity from std::string (e.g. from file)

Note
Do not call this from derived classes unless you understand its limitations

References read_checkpoint().

Member Function Documentation

Entity::OP protocols::genetic_algorithm::Entity::clone ( ) const
virtual
core::Real protocols::genetic_algorithm::Entity::fitness ( ) const
virtual
bool protocols::genetic_algorithm::Entity::fitness_valid ( ) const
virtual

References fitness_valid_.

bool protocols::genetic_algorithm::Entity::operator< ( Entity const &  other) const
virtual

References fitness(), and fitness_.

Entity & protocols::genetic_algorithm::Entity::operator= ( Entity const &  rhs)

References traits_.

bool protocols::genetic_algorithm::Entity::operator== ( Entity const &  other) const
virtual

References traits_.

bool protocols::genetic_algorithm::Entity::read_checkpoint ( std::istream &  is)
virtual
void protocols::genetic_algorithm::Entity::set_entity_element ( core::Size  index,
EntityElementOP  element 
)
virtual
void protocols::genetic_algorithm::Entity::set_fitness ( core::Real  val)
virtual
void protocols::genetic_algorithm::Entity::set_traits ( EntityElements const &  traits)
virtual
void protocols::genetic_algorithm::Entity::set_traits_size ( core::Size  size)
virtual

References fitness_valid_, and traits_.

void protocols::genetic_algorithm::Entity::show ( std::ostream &  os) const
virtual
std::string protocols::genetic_algorithm::Entity::to_string ( ) const
virtual

References show().

EntityElements const & protocols::genetic_algorithm::Entity::traits ( ) const
virtual
std::string protocols::genetic_algorithm::Entity::traits_string ( ) const
virtual

References traits_.

void protocols::genetic_algorithm::Entity::write_checkpoint ( std::ostream &  os) const
virtual

Member Data Documentation

core::Real protocols::genetic_algorithm::Entity::fitness_
private
bool protocols::genetic_algorithm::Entity::fitness_valid_
private
EntityElements protocols::genetic_algorithm::Entity::traits_
private

The documentation for this class was generated from the following files: