Open 3D Engine PhysX Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Protected Member Functions | List of all members
NumericalMethods::Optimization::Function Class Referenceabstract

#include <Optimization.h>

Inherited by PhysX::JointLimitOptimizer::D6JointLimitFitter.

Public Member Functions

AZ::Outcome< double, FunctionOutcome > Execute (const AZStd::vector< double > &x) const
 Used internally by solver routines to perform function evaluations.
 
virtual AZ::u32 GetDimension () const =0
 

Protected Member Functions

virtual AZ::Outcome< double, FunctionOutcome > ExecuteImpl (const AZStd::vector< double > &x) const =0
 

Detailed Description

Class used to represent functions to be optimized. To set up a particular function for optimization, derive from this class and override the GetDimension and ExecuteImpl methods.

Member Function Documentation

◆ ExecuteImpl()

virtual AZ::Outcome<double, FunctionOutcome> NumericalMethods::Optimization::Function::ExecuteImpl ( const AZStd::vector< double > &  x) const
protectedpure virtual

The actual implementation of the function evaluation. This should be overridden with the implementation for the particular function it is desired to optimize.

◆ GetDimension()

virtual AZ::u32 NumericalMethods::Optimization::Function::GetDimension ( ) const
pure virtual

The number of parameters the function takes. For example, the function f(x, y) = x * y takes 2 parameters.

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