Skip to content

Apply more polishing #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged

Apply more polishing #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions 2025R2/optiSLang-python-api/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
Copy link

@wiz-inc-572fc38784 wiz-inc-572fc38784 bot Mar 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Info Sensitive Data Finding

Other

More Details
Attribute Value
Data Classifier Other/Ansys Product Library
Data Classifier ID CUSTOM-bf52ecf9-8981-496e-96f6-18c88acdd79f

Sampled Examples

Key Value
globalMetadata/product ***
globalMetadata/summary ***
globalMetadata/title ***

Rule ID: CUSTOM-bf52ecf9-8981-496e-96f6-18c88acdd79f

"build": {
"globalMetadata": {
"title": "optiSLang Python API 2025 R2 dev (701)",
"title": "optiSLang Python API 2025 R2 dev",
"summary": "optiSLang Python API",
"version": "2025 R2 dev (701)",
"version": "2025 R2 dev",
"product": "optiSLang",
"programming language": "Python",
"product collection": "Connect",
Expand Down
48 changes: 24 additions & 24 deletions 2025R2/optiSLang-python-api/modules/PyARSM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,100 +6,100 @@

<a id="PyARSM.Arsm.__init__"></a>

### \_\_init_\_(arg2: [OptimizerSettingsARSM](#PyARSM.OptimizerSettingsARSM))
#### \_\_init_\_(arg2: [OptimizerSettingsARSM](#PyARSM.OptimizerSettingsARSM))

<a id="PyARSM.Arsm.get_iteration_number"></a>

### get_iteration_number() → int
#### get_iteration_number() → int

<a id="PyARSM.Arsm.set_responses"></a>

### set_responses(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type))
#### set_responses(arg2: [matrix_type](dynardo_py_algorithms.md#dynardo_py_algorithms.matrix_type))

<a id="PyARSM.Arsm.set_terminated"></a>

### set_terminated()
#### set_terminated()

<a id="PyARSM.OptimizerSettingsARSM"></a>

## *class* PyARSM.OptimizerSettingsARSM

<a id="PyARSM.OptimizerSettingsARSM.__init__"></a>

### \_\_init_\_()
#### \_\_init_\_()

<a id="PyARSM.OptimizerSettingsARSM.get_doe_settings"></a>

### get_doe_settings() → [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings)
#### get_doe_settings() → [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings)

<a id="PyARSM.OptimizerSettingsARSM.get_max_iteration"></a>

### get_max_iteration() → int
#### get_max_iteration() → int

<a id="PyARSM.OptimizerSettingsARSM.get_min_iteration"></a>

### get_min_iteration() → int
#### get_min_iteration() → int

<a id="PyARSM.OptimizerSettingsARSM.get_min_objective_diff"></a>

### get_min_objective_diff() → float
#### get_min_objective_diff() → float

<a id="PyARSM.OptimizerSettingsARSM.get_min_parameter_diff"></a>

### get_min_parameter_diff() → float
#### get_min_parameter_diff() → float

<a id="PyARSM.OptimizerSettingsARSM.get_min_range"></a>

### get_min_range() → float
#### get_min_range() → float

<a id="PyARSM.OptimizerSettingsARSM.get_order"></a>

### get_order() → int
#### get_order() → int

<a id="PyARSM.OptimizerSettingsARSM.get_start_range"></a>

### get_start_range() → float
#### get_start_range() → float

<a id="PyARSM.OptimizerSettingsARSM.set_box_cox"></a>

### set_box_cox(arg2: bool)
#### set_box_cox(arg2: bool)

<a id="PyARSM.OptimizerSettingsARSM.set_doe_settings"></a>

### set_doe_settings(arg2: [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings))
#### set_doe_settings(arg2: [DOESettings](py_doe_settings.md#py_doe_settings.DOESettings))

<a id="PyARSM.OptimizerSettingsARSM.set_evaluate_criteria"></a>

### set_evaluate_criteria(arg2: bool)
#### set_evaluate_criteria(arg2: bool)

<a id="PyARSM.OptimizerSettingsARSM.set_max_iteration"></a>

### set_max_iteration(arg2: int)
#### set_max_iteration(arg2: int)

<a id="PyARSM.OptimizerSettingsARSM.set_min_iteration"></a>

### set_min_iteration(arg2: int)
#### set_min_iteration(arg2: int)

<a id="PyARSM.OptimizerSettingsARSM.set_min_objective_diff"></a>

### set_min_objective_diff(arg2: float)
#### set_min_objective_diff(arg2: float)

<a id="PyARSM.OptimizerSettingsARSM.set_min_parameter_diff"></a>

### set_min_parameter_diff(arg2: float)
#### set_min_parameter_diff(arg2: float)

<a id="PyARSM.OptimizerSettingsARSM.set_min_range"></a>

### set_min_range(arg2: float)
#### set_min_range(arg2: float)

<a id="PyARSM.OptimizerSettingsARSM.set_mixed_terms"></a>

### set_mixed_terms(arg2: bool)
#### set_mixed_terms(arg2: bool)

<a id="PyARSM.OptimizerSettingsARSM.set_order"></a>

### set_order(arg2: int)
#### set_order(arg2: int)

<a id="PyARSM.OptimizerSettingsARSM.set_start_range"></a>

### set_start_range(arg2: float)
#### set_start_range(arg2: float)
16 changes: 8 additions & 8 deletions 2025R2/optiSLang-python-api/modules/PyMemetic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,32 @@

<a id="PyMemetic.Memetic.__init__"></a>

### \_\_init_\_()
#### \_\_init_\_()

### \_\_init_\_(arg2: [MemeticSettings](#PyMemetic.MemeticSettings))
#### \_\_init_\_(arg2: [MemeticSettings](#PyMemetic.MemeticSettings))

<a id="PyMemetic.MemeticSettings"></a>

## *class* PyMemetic.MemeticSettings

<a id="PyMemetic.MemeticSettings.__init__"></a>

### \_\_init_\_()
#### \_\_init_\_()

### \_\_init_\_()
#### \_\_init_\_()

<a id="PyMemetic.MemeticSettings.set_inner_optimizer_settings"></a>

### set_inner_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase))
#### set_inner_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase))

<a id="PyMemetic.MemeticSettings.set_outer_optimizer_settings"></a>

### set_outer_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase))
#### set_outer_optimizer_settings(arg2: [PyOptimizerBase.SettingsBase](PyOptimizerBase.md#PyOptimizerBase.SettingsBase))

<a id="PyMemetic.MemeticSettings.set_parameter_types"></a>

### set_parameter_types(arg2: [DeterministicTypeVec](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicTypeVec))
#### set_parameter_types(arg2: [DeterministicTypeVec](dynardo_py_algorithms.md#dynardo_py_algorithms.DeterministicTypeVec))

<a id="PyMemetic.MemeticSettings.set_seed"></a>

### set_seed(arg2: int)
#### set_seed(arg2: int)
50 changes: 25 additions & 25 deletions 2025R2/optiSLang-python-api/modules/PyNLPQLP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,132 +8,132 @@

<a id="PyNLPQLP.DiffType.BACKWARD"></a>

### BACKWARD *= PyNLPQLP.DiffType.BACKWARD*
#### BACKWARD *= PyNLPQLP.DiffType.BACKWARD*

<a id="PyNLPQLP.DiffType.CENTRAL"></a>

### CENTRAL *= PyNLPQLP.DiffType.CENTRAL*
#### CENTRAL *= PyNLPQLP.DiffType.CENTRAL*

<a id="PyNLPQLP.DiffType.FORWARD"></a>

### FORWARD *= PyNLPQLP.DiffType.FORWARD*
#### FORWARD *= PyNLPQLP.DiffType.FORWARD*

<a id="PyNLPQLP.DiffType.FOURTH_ORDER"></a>

### FOURTH_ORDER *= PyNLPQLP.DiffType.FOURTH_ORDER*
#### FOURTH_ORDER *= PyNLPQLP.DiffType.FOURTH_ORDER*

<a id="PyNLPQLP.NLPQLP"></a>

## *class* PyNLPQLP.NLPQLP

<a id="PyNLPQLP.NLPQLP.__init__"></a>

### \_\_init_\_()
#### \_\_init_\_()

### \_\_init_\_(arg2: [SettingsNLPQLP](#PyNLPQLP.SettingsNLPQLP))
#### \_\_init_\_(arg2: [SettingsNLPQLP](#PyNLPQLP.SettingsNLPQLP))

<a id="PyNLPQLP.SettingsNLPQLP"></a>

## *class* PyNLPQLP.SettingsNLPQLP

<a id="PyNLPQLP.SettingsNLPQLP.__init__"></a>

### \_\_init_\_()
#### \_\_init_\_()

<a id="PyNLPQLP.SettingsNLPQLP.get_accuracy"></a>

### get_accuracy() → float
#### get_accuracy() → float

Get tolerance by which optimality conditions are met.

<a id="PyNLPQLP.SettingsNLPQLP.get_gradient_dx"></a>

### get_gradient_dx() → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)
#### get_gradient_dx() → [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type)

Get differentiation step size.

<a id="PyNLPQLP.SettingsNLPQLP.get_line_search_stack_size"></a>

### get_line_search_stack_size() → int
#### get_line_search_stack_size() → int

Get value of nonmonotonous line search stack size.

<a id="PyNLPQLP.SettingsNLPQLP.get_max_num_function_calls"></a>

### get_max_num_function_calls() → int
#### get_max_num_function_calls() → int

Get the maximum allowed number of function calls.

<a id="PyNLPQLP.SettingsNLPQLP.get_max_step_size"></a>

### get_max_step_size() → int
#### get_max_step_size() → int

<a id="PyNLPQLP.SettingsNLPQLP.get_number_of_parallel_line_searches"></a>

### get_number_of_parallel_line_searches() → int
#### get_number_of_parallel_line_searches() → int

Get number of line searches running parallel.

<a id="PyNLPQLP.SettingsNLPQLP.get_numerical_differences"></a>

### get_numerical_differences() → [DiffType](#PyNLPQLP.DiffType)
#### get_numerical_differences() → [DiffType](#PyNLPQLP.DiffType)

Get value used for the differentiaion scheme.

<a id="PyNLPQLP.SettingsNLPQLP.min_line_search_stepsize"></a>

### *property* min_line_search_stepsize
#### *property* min_line_search_stepsize

Default 0 means auto detection of step size.

<a id="PyNLPQLP.SettingsNLPQLP.set_accuracy"></a>

### set_accuracy(arg2: float)
#### set_accuracy(arg2: float)

Set tolerance by which optimality conditions are met.

<a id="PyNLPQLP.SettingsNLPQLP.set_gradient_dx"></a>

### set_gradient_dx(arg2: float)
#### set_gradient_dx(arg2: float)

### set_gradient_dx(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type))
#### set_gradient_dx(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type))

[0] Set differentiation step size.

[1] Set differentiation step size.

<a id="PyNLPQLP.SettingsNLPQLP.set_line_search_stack_size"></a>

### set_line_search_stack_size(arg2: int)
#### set_line_search_stack_size(arg2: int)

Set value of nonmonotonous line search stack size.

<a id="PyNLPQLP.SettingsNLPQLP.set_max_num_function_calls"></a>

### set_max_num_function_calls(arg2: int)
#### set_max_num_function_calls(arg2: int)

Set the maximum allowed number of function calls.

<a id="PyNLPQLP.SettingsNLPQLP.set_max_step_size"></a>

### set_max_step_size(arg2: float)
#### set_max_step_size(arg2: float)

### set_max_step_size(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type))
#### set_max_step_size(arg2: [vector_type](dynardo_py_algorithms.md#dynardo_py_algorithms.vector_type))

<a id="PyNLPQLP.SettingsNLPQLP.set_number_of_parallel_line_searches"></a>

### set_number_of_parallel_line_searches(arg2: int)
#### set_number_of_parallel_line_searches(arg2: int)

Set number of line searches running parallel.

<a id="PyNLPQLP.SettingsNLPQLP.set_numerical_differences"></a>

### set_numerical_differences(arg2: [DiffType](#PyNLPQLP.DiffType))
#### set_numerical_differences(arg2: [DiffType](#PyNLPQLP.DiffType))

Set value used for the differentiaion scheme.

<a id="PyNLPQLP.SettingsNLPQLP.use_initial_stepsize_limit"></a>

### *property* use_initial_stepsize_limit
#### *property* use_initial_stepsize_limit

Initial stepsize limit.
Loading