funcy  1.6.1
Public Member Functions | List of all members
funcy::Sin Struct Reference

Sine function (based on sin(double) in <cmath>). More...

#include <sine.h>

Inheritance diagram for funcy::Sin:
Inheritance graph
[legend]
Collaboration diagram for funcy::Sin:
Collaboration graph
[legend]

Public Member Functions

 Sin (double x=0) noexcept
 Constructor. More...
 
void update (double x) noexcept
 Set point of evaluation. More...
 
double d0 () const noexcept
 Function value. More...
 
double d1 (double dx=1.) const noexcept
 First (directional) derivative. More...
 
double d2 (double dx=1., double dy=1.) const noexcept
 Second (directional) derivative. More...
 
double d3 (double dx=1., double dy=1., double dz=1.) const noexcept
 Third (directional) derivative. More...
 

Detailed Description

Sine function (based on sin(double) in <cmath>).

For scalar functions directional derivatives are less interesting. Incorporating this function as building block for more complex functions requires directional derivatives. These occur during applications of the chain rule.

Constructor & Destructor Documentation

◆ Sin()

funcy::Sin::Sin ( double  x = 0)
inlineexplicitnoexcept

Constructor.

Parameters
xpoint of evaluation

Member Function Documentation

◆ d0()

double funcy::Sin::d0 ( ) const
inlinenoexcept

Function value.

◆ d1()

double funcy::Sin::d1 ( double  dx = 1.) const
inlinenoexcept

First (directional) derivative.

◆ d2()

double funcy::Sin::d2 ( double  dx = 1.,
double  dy = 1. 
) const
inlinenoexcept

Second (directional) derivative.

◆ d3()

double funcy::Sin::d3 ( double  dx = 1.,
double  dy = 1.,
double  dz = 1. 
) const
inlinenoexcept

Third (directional) derivative.

◆ update()

void funcy::Sin::update ( double  x)
inlinenoexcept

Set point of evaluation.


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