optiSLang 3D Postprocessing Script API 2025 R1

CreatePolynomialModel Class Reference

Last update: 16.07.2025

Defines a PolynomialModel Used Properties: More...

Public Member Functions

virtual string __str__ ()
 Output function used in python context. Use this function to print instances of this class in python. More...
 
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.
 
ModelBase * compute (::data_handler::DataHandlerBase datahandler, TrainingPlanBase training_plan, quality_measure::QualityMeasureBase quality_measure)
 Builds the model from the given samples and returns the model. More...
 
 CreatePolynomialModel ()
 Creates an default initialized instance of this class.
 
 CreatePolynomialModel (CreatePolynomialModel other)
 Copies an instance of this class.
 
virtual PropertyList getProperties ()
 Returns the properties stored by this user.
 
virtual bool isValid (::data_handler::DataHandlerBase datahandler, TrainingPlanBase training_plan) override
 Destroys an instance of this class. More...
 
CreatePolynomialModel operator= (CreatePolynomialModel)
 Copies an instance of this class.
 
virtual transferProperties (PropertyList property_list)
 Convenience function to transfer a complete PropertyList into the model. More...
 

Public Attributes

MixedTermInteraction interaction
 Specifies if the mixed terms in the polynomial model shall be considered or not.
 
uint64_t max_order
 Specifies the polynomial models maximal order (degree) valid value range of [TODO], Auto ???
 
string node_name
 
int order
 Specifies the polynomial models actual order valid value range of [TODO], -1 : Auto - TODO.
 
Transformation value_transformation
 Specifies the type of value transformation the model shall use.
 
string working_dir
 

Detailed Description

Defines a PolynomialModel Used Properties:

  • CoefficientFactorProperty
  • ComplexityProperty
  • DeltaErrorInputProperty

Member Function Documentation

◆ __str__()

virtual string __str__ ( )
virtualinherited

Output function used in python context. Use this function to print instances of this class in python.

Returns
string containing the object

Reimplemented in CreateCustomModel.

◆ compute()

ModelBase* compute ( ::data_handler::DataHandlerBase  datahandler,
TrainingPlanBase  training_plan,
quality_measure::QualityMeasureBase  quality_measure 
)

Builds the model from the given samples and returns the model.

Parameters
datahandlerThe datahandler that contains the samples
training_planThe training plan that specifies how the model will be trained
quality_measureThe quality measure that allows to compute a models approximation quality
Returns
The trained model iff not cancelled

◆ isValid()

virtual bool isValid ( ::data_handler::DataHandlerBase  datahandler,
TrainingPlanBase  training_plan 
)
overridevirtual

Destroys an instance of this class.

This function checks if the model can validly be trained from the given samples

Parameters
samplesThe samples the model shall be trained with.
Returns
True iff th emodel can be trained with the configuration data, the properties and samples

Implements CreateModelBase.

◆ 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