1 core.parameters.VectorParameter
core.parameters.VectorParameter(name, size, values=None)A vector of parameters for array-valued constants.
VectorParameter creates a collection of scalar Parameter instances that can be updated together, useful for time-varying vectors like demand forecasts or price curves.
1.1 Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| name | str | Base name for the parameters. Elements are named “{name}[i]”. | required |
| size | int | Number of elements. | required |
| values | ArrayLike | float | None | Initial values (array-like or scalar for all elements). | None |
1.2 Example
from optyx import VectorVariable, VectorParameter, dot
2 Time-varying prices
prices = VectorParameter(“price”, 24, values=[100]*24) quantities = VectorVariable(“q”, 24, lb=0)
revenue = dot(prices, quantities)
3 Update prices for next solve
prices.set([105, 110, 115, …]) # New price forecast
3.1 Methods
| Name | Description |
|---|---|
| get_values | Get all current parameter values as array. |
| set | Update all parameter values. |
| to_numpy | Get all current parameter values as numpy array. |
3.1.1 get_values
core.parameters.VectorParameter.get_values()Get all current parameter values as array.
3.1.2 set
core.parameters.VectorParameter.set(values)Update all parameter values.
3.1.2.1 Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| values | ArrayLike | New values (array-like of length size). | required |
3.1.2.2 Raises
| Name | Type | Description |
|---|---|---|
| ValueError | If values length doesn’t match size. |
3.1.3 to_numpy
core.parameters.VectorParameter.to_numpy()Get all current parameter values as numpy array.
This is an alias for get_values() for consistency with VectorVariable.to_numpy().