---

Sundance::ADReal Class Reference

First-order automatic differentiation of a multivariable function. More...

#include <ADReal.h>

List of all members.

Public Methods

• ADReal ()

  Create an ADReal with value and gradient = 0.
  
  

• ADReal (double value, int direction, int spatialDimension)

  Create an ADReal object that varies linearly with one coordinate direction.
  
  

• ADReal (double value, int spatialDimension)

  Create a constant-valued ADReal object in a multidimensional space.
  
  

• ADReal operator- () const

  unary minus
  
  

• ADReal & operator+= (const ADReal &other)

  reflexive addition
  
  

• ADReal & operator-= (const ADReal &other)

  reflexive subtraction
  
  

• ADReal & operator *= (const ADReal &other)

  reflexive multiplication
  
  

• ADReal & operator/= (const ADReal &other)

  reflexive division
  
  

• ADReal & operator+= (const double &scalar)

  reflexive scalar addition
  
  

• ADReal & operator-= (const double &scalar)

  reflexive scalar subtraction
  
  

• ADReal & operator *= (const double &scalar)

  reflexive scalar multiplication
  
  

• ADReal & operator/= (const double &scalar)

  reflexive scalar division
  
  

• ADReal operator+ (const ADReal &other) const

  addition
  
  

• ADReal operator- (const ADReal &other) const

  subtraction
  
  

• ADReal operator * (const ADReal &other) const

  multiplication
  
  

• ADReal operator/ (const ADReal &other) const

  division
  
  

• ADReal operator+ (const double &scalar) const

  scalar addition
  
  

• ADReal operator- (const double &scalar) const

  scalar subtraction
  
  

• ADReal operator * (const double &scalar) const

  scalar multiplication
  
  

• ADReal operator/ (const double &scalar) const

  scalar division
  
  

• const double & value () const

  get the value
  
  

• const DenseSerialVector & gradient () const

  get the gradient
  
  

• void reciprocate ()

Static Public Methods

• bool unitTest ()

Private Attributes

• double value_
• DenseSerialVector gradient_

---

Detailed Description

Author:

Kevin Long

Definition at line 16 of file ADReal.h.

---

Constructor & Destructor Documentation

Sundance::ADReal::ADReal (    )  [inline]

Definition at line 20 of file ADReal.h. References gradient_, and value_.

Sundance::ADReal::ADReal (  double    value, int    direction, int    spatialDimension )  [inline]

Definition at line 23 of file ADReal.h. References gradient_, value(), and value_.

Sundance::ADReal::ADReal (  double    value, int    spatialDimension )  [inline]

Definition at line 29 of file ADReal.h. References gradient_, value(), and value_.

---

Member Function Documentation

ADReal Sundance::ADReal::operator- (    )  const

ADReal& Sundance::ADReal::operator+= (  const ADReal &    other )

ADReal& Sundance::ADReal::operator-= (  const ADReal &    other )

ADReal& Sundance::ADReal::operator *= (  const ADReal &    other )

ADReal& Sundance::ADReal::operator/= (  const ADReal &    other )

ADReal& Sundance::ADReal::operator+= (  const double &    scalar )

ADReal& Sundance::ADReal::operator-= (  const double &    scalar )

ADReal& Sundance::ADReal::operator *= (  const double &    scalar )

ADReal& Sundance::ADReal::operator/= (  const double &    scalar )

ADReal Sundance::ADReal::operator+ (  const ADReal &    other )  const

ADReal Sundance::ADReal::operator- (  const ADReal &    other )  const

ADReal Sundance::ADReal::operator * (  const ADReal &    other )  const

ADReal Sundance::ADReal::operator/ (  const ADReal &    other )  const

ADReal Sundance::ADReal::operator+ (  const double &    scalar )  const

ADReal Sundance::ADReal::operator- (  const double &    scalar )  const

ADReal Sundance::ADReal::operator * (  const double &    scalar )  const

ADReal Sundance::ADReal::operator/ (  const double &    scalar )  const

const double& Sundance::ADReal::value (    )  const [inline]

Definition at line 72 of file ADReal.h. References value_. Referenced by ADReal().

const DenseSerialVector& Sundance::ADReal::gradient (    )  const [inline]

Definition at line 74 of file ADReal.h. References gradient_.

void Sundance::ADReal::reciprocate (    )

bool Sundance::ADReal::unitTest (    )  [static]

---

Member Data Documentation

double Sundance::ADReal::value_ [private]

Definition at line 80 of file ADReal.h. Referenced by ADReal(), and value().

DenseSerialVector Sundance::ADReal::gradient_ [private]

Definition at line 81 of file ADReal.h. Referenced by ADReal(), and gradient().

---

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

• ADReal.h

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by