ReFRACtor
FullPhysics::AutoDerivativeWithUnit< T > Class Template Reference

This is a AutoDerivative that also has units associated with it. More...

#include <auto_derivative_with_unit.h>

+ Inheritance diagram for FullPhysics::AutoDerivativeWithUnit< T >:
+ Collaboration diagram for FullPhysics::AutoDerivativeWithUnit< T >:

Public Member Functions

 AutoDerivativeWithUnit ()
 
 AutoDerivativeWithUnit (const AutoDerivative< T > &V, const Unit &U)
 
 AutoDerivativeWithUnit (const AutoDerivative< T > &V, const std::string &U)
 
 AutoDerivativeWithUnit (const AutoDerivative< T > &V)
 
 AutoDerivativeWithUnit (const T &V)
 
 AutoDerivativeWithUnit (const DoubleWithUnit &V)
 
AutoDerivativeWithUnit< T > convert (const Unit &R) const
 Convert to the given units. More...
 
AutoDerivativeWithUnit< T > & operator*= (const AutoDerivativeWithUnit< T > &D)
 Basic math operators for class. More...
 
AutoDerivativeWithUnit< T > & operator+= (const AutoDerivativeWithUnit< T > &D)
 
AutoDerivativeWithUnit< T > & operator-= (const AutoDerivativeWithUnit< T > &D)
 
AutoDerivativeWithUnit< T > & operator/= (const AutoDerivativeWithUnit< T > &D)
 
void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 

Public Attributes

Unit units
 
AutoDerivative< T > value
 

Detailed Description

template<class T>
class FullPhysics::AutoDerivativeWithUnit< T >

This is a AutoDerivative that also has units associated with it.

This is a simple structure that just keeps these two things together.

Definition at line 15 of file auto_derivative_with_unit.h.

Constructor & Destructor Documentation

◆ AutoDerivativeWithUnit() [1/6]

template<class T>
FullPhysics::AutoDerivativeWithUnit< T >::AutoDerivativeWithUnit ( )
inline

Definition at line 20 of file auto_derivative_with_unit.h.

◆ AutoDerivativeWithUnit() [2/6]

template<class T>
FullPhysics::AutoDerivativeWithUnit< T >::AutoDerivativeWithUnit ( const AutoDerivative< T > &  V,
const Unit U 
)
inline

Definition at line 21 of file auto_derivative_with_unit.h.

◆ AutoDerivativeWithUnit() [3/6]

template<class T>
FullPhysics::AutoDerivativeWithUnit< T >::AutoDerivativeWithUnit ( const AutoDerivative< T > &  V,
const std::string &  U 
)
inline

Definition at line 23 of file auto_derivative_with_unit.h.

◆ AutoDerivativeWithUnit() [4/6]

template<class T>
FullPhysics::AutoDerivativeWithUnit< T >::AutoDerivativeWithUnit ( const AutoDerivative< T > &  V)
inline

Definition at line 25 of file auto_derivative_with_unit.h.

◆ AutoDerivativeWithUnit() [5/6]

template<class T>
FullPhysics::AutoDerivativeWithUnit< T >::AutoDerivativeWithUnit ( const T &  V)
inline

Definition at line 27 of file auto_derivative_with_unit.h.

◆ AutoDerivativeWithUnit() [6/6]

template<class T>
FullPhysics::AutoDerivativeWithUnit< T >::AutoDerivativeWithUnit ( const DoubleWithUnit V)
inline

Definition at line 29 of file auto_derivative_with_unit.h.

Member Function Documentation

◆ convert()

template<class T>
AutoDerivativeWithUnit<T> FullPhysics::AutoDerivativeWithUnit< T >::convert ( const Unit R) const
inline

Convert to the given units.

Definition at line 55 of file auto_derivative_with_unit.h.

◆ operator*=()

template<class T>
AutoDerivativeWithUnit<T>& FullPhysics::AutoDerivativeWithUnit< T >::operator*= ( const AutoDerivativeWithUnit< T > &  D)
inline

Basic math operators for class.

Definition at line 39 of file auto_derivative_with_unit.h.

◆ operator+=()

template<class T>
AutoDerivativeWithUnit<T>& FullPhysics::AutoDerivativeWithUnit< T >::operator+= ( const AutoDerivativeWithUnit< T > &  D)
inline

Definition at line 45 of file auto_derivative_with_unit.h.

◆ operator-=()

template<class T>
AutoDerivativeWithUnit<T>& FullPhysics::AutoDerivativeWithUnit< T >::operator-= ( const AutoDerivativeWithUnit< T > &  D)
inline

Definition at line 48 of file auto_derivative_with_unit.h.

◆ operator/=()

template<class T>
AutoDerivativeWithUnit<T>& FullPhysics::AutoDerivativeWithUnit< T >::operator/= ( const AutoDerivativeWithUnit< T > &  D)
inline

Definition at line 42 of file auto_derivative_with_unit.h.

◆ print()

template<class T>
void FullPhysics::AutoDerivativeWithUnit< T >::print ( std::ostream &  Os) const
inline

Definition at line 58 of file auto_derivative_with_unit.h.

◆ print_to_string()

std::string FullPhysics::Printable< AutoDerivativeWithUnit< T > >::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.

Member Data Documentation

◆ units

template<class T>
Unit FullPhysics::AutoDerivativeWithUnit< T >::units

Definition at line 32 of file auto_derivative_with_unit.h.

◆ value

template<class T>
AutoDerivative<T> FullPhysics::AutoDerivativeWithUnit< T >::value

Definition at line 31 of file auto_derivative_with_unit.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:12