ReFRACtor
FullPhysics::LogLinearInterpolate< TX, TY > Class Template Reference

Wrapper around LinearInterpolate that uses log(x) rather than x in interpolating. More...

#include <log_interpolate.h>

+ Inheritance diagram for FullPhysics::LogLinearInterpolate< TX, TY >:
+ Collaboration diagram for FullPhysics::LogLinearInterpolate< TX, TY >:

Public Types

typedef LinearInterpolate< TX, TY >::BehaviorOutOfRange BehaviorOutOfRange
 

Public Member Functions

 LogLinearInterpolate ()
 Constructor. More...
 
template<class I1 , class I2 >
 LogLinearInterpolate (I1 xstart, I1 xend, I2 ystart, BehaviorOutOfRange Out_of_range=BehaviorOutOfRange(0))
 
TY operator() (const TX &x) const
 
void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 

Detailed Description

template<class TX, class TY>
class FullPhysics::LogLinearInterpolate< TX, TY >

Wrapper around LinearInterpolate that uses log(x) rather than x in interpolating.

Definition at line 14 of file log_interpolate.h.

Member Typedef Documentation

◆ BehaviorOutOfRange

template<class TX , class TY >
typedef LinearInterpolate<TX, TY>::BehaviorOutOfRange FullPhysics::LogLinearInterpolate< TX, TY >::BehaviorOutOfRange

Definition at line 18 of file log_interpolate.h.

Constructor & Destructor Documentation

◆ LogLinearInterpolate() [1/2]

template<class TX , class TY >
FullPhysics::LogLinearInterpolate< TX, TY >::LogLinearInterpolate ( )
inline

Constructor.

This takes iterators to give x and y, along with the behavior when called with out of range data.

Definition at line 25 of file log_interpolate.h.

◆ LogLinearInterpolate() [2/2]

template<class TX , class TY >
template<class I1 , class I2 >
FullPhysics::LogLinearInterpolate< TX, TY >::LogLinearInterpolate ( I1  xstart,
I1  xend,
I2  ystart,
BehaviorOutOfRange  Out_of_range = BehaviorOutOfRange(0) 
)
inline

Definition at line 31 of file log_interpolate.h.

Member Function Documentation

◆ operator()()

template<class TX , class TY >
TY FullPhysics::LogLinearInterpolate< TX, TY >::operator() ( const TX &  x) const
inline

Definition at line 40 of file log_interpolate.h.

◆ print()

template<class TX , class TY >
void FullPhysics::LogLinearInterpolate< TX, TY >::print ( std::ostream &  Os) const
inline

Definition at line 44 of file log_interpolate.h.

◆ print_to_string()

std::string FullPhysics::Printable< LogLinearInterpolate< TX, TY > >::print_to_string ( ) const
inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.


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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:13