protocols::multistate_design::PartitionAggregateFunction Class Reference

#include <PartitionAggregateFunction.hh>

Inheritance diagram for protocols::multistate_design::PartitionAggregateFunction:

Public Types
typedef utility::pointer::shared_ptr< PartitionAggregateFunction >	OP
typedef utility::pointer::shared_ptr< PartitionAggregateFunction const >	COP
Public Types inherited from protocols::multistate_design::MultiStateAggregateFunction
typedef utility::pointer::shared_ptr< MultiStateAggregateFunction >	OP
typedef utility::pointer::shared_ptr< MultiStateAggregateFunction const >	COP

Public Member Functions
	PartitionAggregateFunction ()
	PartitionAggregateFunction (core::Real temp, core::Real anchor_offset, bool const compare_to_ground_state=false)
	~PartitionAggregateFunction () override
virtual core::Real	temp () const
virtual void	set_temp (core::Real temp)
virtual core::Real	anchor_offset () const
virtual void	set_anchor_offset (core::Real offset)
core::Real	evaluate (utility::vector1< core::Real > const &single_state_fitnesses, MultiStateFitnessFunction &fitness_function) const override
Public Member Functions inherited from protocols::multistate_design::MultiStateAggregateFunction
	MultiStateAggregateFunction ()
	~MultiStateAggregateFunction () override=default

Private Attributes
core::Real	temp_
core::Real	anchor_offset_
bool const	compare_all_to_ground_state_

Member Typedef Documentation

COP

typedef utility::pointer::shared_ptr< PartitionAggregateFunction const > protocols::multistate_design::PartitionAggregateFunction::COP

OP

typedef utility::pointer::shared_ptr< PartitionAggregateFunction > protocols::multistate_design::PartitionAggregateFunction::OP

Constructor & Destructor Documentation

PartitionAggregateFunction() [1/2]

protocols::multistate_design::PartitionAggregateFunction::PartitionAggregateFunction

(

)

PartitionAggregateFunction() [2/2]

protocols::multistate_design::PartitionAggregateFunction::PartitionAggregateFunction	(	core::Real	temp,
		core::Real	anchor_offset,
		bool const	compare_to_ground_state = false
	)

~PartitionAggregateFunction()

protocols::multistate_design::PartitionAggregateFunction::~PartitionAggregateFunction ( )

overridedefault

Member Function Documentation

anchor_offset()

core::Real protocols::multistate_design::PartitionAggregateFunction::anchor_offset ( ) const

virtual

References anchor_offset_.

evaluate()

core::Real protocols::multistate_design::PartitionAggregateFunction::evaluate ( utility::vector1< core::Real > const &  single_state_fitnesses, MultiStateFitnessFunction &  fitness_function  ) const

overridevirtual

SJF see https://wiki.rosettacommons.org/index.php/IDDocumentation#ProteinInterfaceMS for explanations on the parameters

Reimplemented from protocols::multistate_design::MultiStateAggregateFunction.

References anchor_offset_, compare_all_to_ground_state_, protocols::multistate_design::MultiStateFitnessFunction::const_states(), protocols::cryst::denom(), core::chemical::element::F, temp_, and protocols::multistate_design::TR().

set_anchor_offset()

void protocols::multistate_design::PartitionAggregateFunction::set_anchor_offset ( core::Real  offset )

virtual

References anchor_offset_.

set_temp()

void protocols::multistate_design::PartitionAggregateFunction::set_temp ( core::Real  temp )

virtual

References temp(), and temp_.

temp()

core::Real protocols::multistate_design::PartitionAggregateFunction::temp ( ) const

virtual

References temp_.

Referenced by set_temp().

Member Data Documentation

anchor_offset_

core::Real protocols::multistate_design::PartitionAggregateFunction::anchor_offset_

private

Referenced by anchor_offset(), evaluate(), and set_anchor_offset().

compare_all_to_ground_state_

bool const protocols::multistate_design::PartitionAggregateFunction::compare_all_to_ground_state_

private

Referenced by evaluate().

temp_

core::Real protocols::multistate_design::PartitionAggregateFunction::temp_

private

Referenced by evaluate(), set_temp(), and temp().

---

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

• src/protocols/multistate_design/PartitionAggregateFunction.hh
• src/protocols/multistate_design/PartitionAggregateFunction.cc