Skip to main content

optiSLang 3D Postprocessing Script API 2025 R1

PolynomialModel Class Reference

Last update: 16.07.2025

Public Types

using InternalModelType = dynardo::math::metamodel::LinearRegression
 

Public Member Functions

virtual addProperty (PropertyBase p)
 Properties that help the ScalarMOP scheduling the Models to be built The properties class needs to be implemented for the specific model type.
 
virtual Matrix evaluate (Matrix points, bool extrapolate=true)=0
 Evaluates the model on the given points and returns the values. More...
 
virtual PropertyList getProperties ()
 Returns the properties stored by this user.
 
PolynomialModel operator= (PolynomialModel)
 Copies an instance of this class.
 
 PolynomialModel ()
 Creates an default initialized instance of this class.
 
 PolynomialModel (InternalModelType *model, quality_measure::ResidualsBase *residuals, string description, PropertyList properties=PropertyList())
 Creates an instance with given a created internal model, the residuals from the training and Properties. You should not call this Constructor by yourself. An instance of this class gets created through the CreatePolynomialModel::compute function. More...
 
 PolynomialModel (PolynomialModel other)
 Copies an instance of this class.
 
virtual transferProperties (PropertyList property_list)
 Convenience function to transfer a complete PropertyList into the model. More...
 

Constructor & Destructor Documentation

◆ PolynomialModel()

PolynomialModel ( InternalModelType *  model,
quality_measure::ResidualsBase *  residuals,
string  description,
PropertyList  properties = PropertyList() 
)

Creates an instance with given a created internal model, the residuals from the training and Properties. You should not call this Constructor by yourself. An instance of this class gets created through the CreatePolynomialModel::compute function.

Parameters
modelA pointer to the internal model type. This Constructor takes ownership of the pointer.
residualsThe residuals from the MOPs competition/training process
descriptionA description of the model to be shown in PP
properties.Certain properies for this model.

Member Function Documentation

◆ evaluate()

virtual Matrix evaluate ( Matrix  points,
bool  extrapolate = true 
)
pure virtualinherited

Evaluates the model on the given points and returns the values.

Parameters
pointsThe input points the model is evaluated on
extrapolateEvaluate the points outside of the bounding box of its training data
Returns
The values of the model on the given points

Implemented in CustomModel, KrigingModel, MLSModel, and RBFModel.

◆ transferProperties()

virtual transferProperties ( PropertyList  property_list)
virtualinherited

Convenience function to transfer a complete PropertyList into the model.

Parameters
property_listThe properties to transfer into this model

Connect with Ansys