Engee documentation

Continuous

Page in progress.

Creates an object for a continuous configurable parameter.

Library

EngeeDesignOptimization

Description

Function Continuous creates an object for a continuous configurable parameter EngeeDesignOptimization.Continuous. A continuous parameter is a numeric parameter that can take any value in a given range. Such a parameter can have a value specified as a scalar, vector, matrix, or array.

Continuous parameters are used to evaluate or optimize configurable parameters in models. Engee. For example, when evaluating parameters using the function optimize You should use the function getParameterFromWorkspace to create objects EngeeDesignOptimization.Continuous, corresponding to the parameters of the model.

Syntax

Function call

  • p = Continuous(name, value) — creates a continuous configurable parameter object p with the name name and the value value.

Properties of the object are available for reading and setting using the operator .. Unspecified properties retain their default values.

Arguments

# name is the name of the parameter

+ line

Details

The name of the continuous configurable parameter, set as a string.

Типы данных

String

# value — parameter value

+ scalar | vector | the matrix | array

Details

The value of a continuous configurable parameter, set as a scalar, vector, matrix, or array.

Типы данных

Float16, Float32, Float64

Output arguments

# p is a continuous parameter

+ object

Details

The object of the continuous parameter.

The object contains the following properties: name, value, minimum, maximum, free, scale, info.

Properties of the object are available for reading and setting using the operator .. Unspecified properties retain their default values.

Example

using EngeeDesignOptimization

# создадим объект непрерывного параметра y с именем p1 и значением 5
y=Continuous("p1",5)

# зададим диапазон для этого параметра
y.minimum=3.5
y.maximum=6.5

# выведем свойства объекта y
println("имя параметра: ",y.name)
println("значение параметра: ",y.value)
println("нижняя граница значения параметра: ",y.minimum)
println("верхняя граница значения параметра: ",y.maximum)
println("варьируемость параметра: ",y.free)
println("коэффициент масштабирования: ",y.scale)
println("наименование величины и единица измерения: ",y.info)
имя параметра: p1
значение параметра: 5.0
нижняя граница значения параметра: 3.5
верхняя граница значения параметра: 6.5
варьируемость параметра: true
коэффициент масштабирования: 1.0
наименование величины и единица измерения: (label = "", unit = "")
Типы данных

EngeeDesignOptimization.Continuous

Features

# minimum — the lower limit of the parameter value

+ −Inf (by default) | scalar | vector | the matrix | array

Details

The lower limit of the parameter value. The dimension of this property is the same as the dimension of value.

If value If it is a non-scalar value, then you can set the lower bounds:

  • for individual elements, for example, p.minimum[1, 2] = -10.0;

  • for all elements, using an assignment with a dot, for example, p.minimum .= -10.0.

Типы данных

Float16, Float32, Float64

# maximum — the upper limit of the parameter value

+ Inf (by default) | scalar | vector | the matrix | array

Details

The upper limit of the parameter value. The dimension of this property is the same as the dimension of value.

If value If it is a non-scalar value, then you can set the upper bounds:

  • for individual elements, for example, p.maximum[1, 2] = 10.0;

  • for all elements, using an assignment with a dot, for example, p.maximum .= 10.0.

Типы данных

Float16, Float32, Float64

# free — parameter variability

+ true (by default) | false | vector | the matrix | array

Details

The variability of the parameter indicates whether the parameter is configurable. The dimension of this property is the same as the dimension of value.

If value If it is a non-scalar value, then you can set the variability:

  • for individual elements, for example, p.free[1, 2] = false or p.free = [false true; true true];

  • for all elements, using an assignment with a dot, for example, p.free .= false.

Типы данных

Bool

# scale — zoom level
1.0 (by default) | scalar | vector | the matrix | array

Details

The zoom level for normalizing the parameter value. The dimension of this property is the same as the dimension of value.

If value If it is a non-scalar value, then you can set the zoom level:

  • for individual elements, for example, p.scale[1, 2] = 2.0;

  • for all elements of the array, using an assignment with a dot, for example, p.scale .= 2.0.

Типы данных

Float16, Float32, Float64

# info — name of quantities and units of measurement

+ (label="", unit="") (by default) | scalar | vector | the matrix | array

Details

The name of the quantity and the unit of measurement, specified as a named tuple with fields label and unit, the values of which are set as strings. The dimension of this property is the same as the dimension of value.

If value If it is a non-scalar quantity, then you can specify the name of the quantity and unit of measurement for a separate element in the following way: p.info[1,2] = (label = "F", unit = "N").

Типы данных

NamedTuple