Rosetta
Public Member Functions | Private Attributes | List of all members
protocols::moves::GeometricFunc Class Reference

Ramps rapidly from the starting value to the final value. Not 1 at x=1. Doesn't really finish at (1,1). func(x) = 1 - exp( -1 * x * inv_xval_at_0p5 * 0.6931 );. More...

#include <RampingMover.hh>

Inheritance diagram for protocols::moves::GeometricFunc:
Inheritance graph
[legend]

Public Member Functions

 GeometricFunc (Real xval_at_0p5)
 Ramps rapidly from the starting value to the final value. Not 1 at x=1. Doesn't really finish at (1,1). More...
 
 GeometricFunc ()
 @default ctor – val of 0.5 produces 0.5 More...
 
 ~GeometricFunc () override
 
Real func (Real x) const override
 func(x) = 1 - exp( -1 * x * inv_xval_at_0p5 * 0.6931 ); More...
 
- Public Member Functions inherited from protocols::moves::RampingFunc
 ~RampingFunc () override
 

Private Attributes

Real inv_xval_at_0p5_
 

Additional Inherited Members

- Public Types inherited from protocols::moves::RampingFunc
typedef core::Real Real
 

Detailed Description

Ramps rapidly from the starting value to the final value. Not 1 at x=1. Doesn't really finish at (1,1). func(x) = 1 - exp( -1 * x * inv_xval_at_0p5 * 0.6931 );.

Constructor & Destructor Documentation

◆ GeometricFunc() [1/2]

protocols::moves::GeometricFunc::GeometricFunc ( Real  xval_at_0p5)

Ramps rapidly from the starting value to the final value. Not 1 at x=1. Doesn't really finish at (1,1).

◆ GeometricFunc() [2/2]

protocols::moves::GeometricFunc::GeometricFunc ( )

@default ctor – val of 0.5 produces 0.5

◆ ~GeometricFunc()

protocols::moves::GeometricFunc::~GeometricFunc ( )
overridedefault

Member Function Documentation

◆ func()

RampingFunc::Real protocols::moves::GeometricFunc::func ( Real  x) const
overridevirtual

func(x) = 1 - exp( -1 * x * inv_xval_at_0p5 * 0.6931 );

Implements protocols::moves::RampingFunc.

References inv_xval_at_0p5_.

Member Data Documentation

◆ inv_xval_at_0p5_

Real protocols::moves::GeometricFunc::inv_xval_at_0p5_
private

Referenced by func().


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