Loading...
Searching...
No Matches
HydroCouple::DifferentialEntry Struct Reference

DifferentialEntry pairs one data item, in one role, with a buffer holding its tangent (forward mode) or cotangent (reverse mode). More...

#include <hydrocouple.h>

Collaboration diagram for HydroCouple::DifferentialEntry:

Public Attributes

const IComponentDataItem * item = nullptr
 The item this derivative belongs to.
 
DifferentialRole role = DifferentialRole::Input
 Which side of the step.
 
BufferDescriptor value
 The tangent or cotangent buffer.
 

Detailed Description

DifferentialEntry pairs one data item, in one role, with a buffer holding its tangent (forward mode) or cotangent (reverse mode).

A plain aggregate, like BufferDescriptor, so that a C-ABI shim can carry it. The buffer always spans the item's whole index space: value.shape equals the item's shape() and value.kind equals its dataKind(), which must be Float32 or Float64. The caller owns the memory; the memory-space rules are those of the data plane (a component that cannot service a space returns false with a message).

Member Data Documentation

◆ item

const IComponentDataItem* HydroCouple::DifferentialEntry::item = nullptr

The item this derivative belongs to.

◆ role

DifferentialRole HydroCouple::DifferentialEntry::role = DifferentialRole::Input

Which side of the step.

◆ value

BufferDescriptor HydroCouple::DifferentialEntry::value

The tangent or cotangent buffer.


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