The AIMMS Function ReferenceContents vii 9 Forecasting Functions 246 9.1 Introduction . . . . . . ....
Transcript of The AIMMS Function ReferenceContents vii 9 Forecasting Functions 246 9.1 Introduction . . . . . . ....
-
AIMMSThe Function Reference
AIMMS AIMMS 4
August 19, 2015
-
Contents
Contents ii
Part I Elementary Computational Operations 2
1 Arithmetic Functions 2
Abs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
ArcCos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
ArcCosh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
ArcSin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
ArcSinh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
ArcTan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ArcTanh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Ceil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Cos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Cosh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Cube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Degrees . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Div . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
ErrorF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Exp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Floor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Log10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
MapVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Max . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Min . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Mod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Radians . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Round . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
ScalarValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Sign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
-
Contents iii
Sin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Sinh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Sqr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Sqrt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Tan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Tanh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Trunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Val . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
2 Set Related Functions 40
ActiveCard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Card . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
CloneElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
ElementCast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
ElementRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
FindUsedElements . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
First . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Last . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Ord . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
RestoreInactiveElements . . . . . . . . . . . . . . . . . . . . . . . 54
RetrieveCurrentVariableValues . . . . . . . . . . . . . . . . . . . 55
SetAddRecursive . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
SetElementAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
SetElementRename . . . . . . . . . . . . . . . . . . . . . . . . . . 58
StringToElement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
SubRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
3 String Manipulation Functions 61
Character . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
CharacterNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
FindNthString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
FindReplaceNthString . . . . . . . . . . . . . . . . . . . . . . . . . 66
FindReplaceStrings . . . . . . . . . . . . . . . . . . . . . . . . . . 68
FindString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
FormatString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
StringCapitalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
StringLength . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
StringOccurrences . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
StringToLower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
StringToUpper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
SubString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
-
Contents iv
4 Unit Functions 77
AtomicUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
ConvertUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
EvaluateUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
StringToUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
5 Time Functions 83
Aggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ConvertReferenceDate . . . . . . . . . . . . . . . . . . . . . . . . 85
CreateTimeTable . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
CurrentToMoment . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
CurrentToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
CurrentToTimeSlot . . . . . . . . . . . . . . . . . . . . . . . . . . 89
DaylightSavingEndDate . . . . . . . . . . . . . . . . . . . . . . . . 90
DaylightSavingStartDate . . . . . . . . . . . . . . . . . . . . . . . 91
DisAggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
MomentToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
MomentToTimeSlot . . . . . . . . . . . . . . . . . . . . . . . . . . 94
PeriodToString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
StringToMoment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
StringToTimeSlot . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
TestDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
TimeSlotCharacteristic . . . . . . . . . . . . . . . . . . . . . . . . 99
TimeSlotToMoment . . . . . . . . . . . . . . . . . . . . . . . . . . 100
TimeSlotToString . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
TimeZoneOffSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
6 Financial Functions 103
6.1 General Conversions . . . . . . . . . . . . . . . . . . . . . . . . . 104
PriceDecimal . . . . . . . . . . . . . . . . . . . . . . . . . 105
PriceFractional . . . . . . . . . . . . . . . . . . . . . . . . 106
RateEffective . . . . . . . . . . . . . . . . . . . . . . . . . 107
RateNominal . . . . . . . . . . . . . . . . . . . . . . . . . 108
6.2 Day Count Bases and Dates . . . . . . . . . . . . . . . . . . . . . 109
Format of date arguments . . . . . . . . . . . . . . . . . 109
Day count bases . . . . . . . . . . . . . . . . . . . . . . . 109
Date differences . . . . . . . . . . . . . . . . . . . . . . . 110
DateDifferenceDays . . . . . . . . . . . . . . . . . . . . . 111
DateDifferenceYearFraction . . . . . . . . . . . . . . . . 112
6.3 Depreciations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
DepreciationLinearLife . . . . . . . . . . . . . . . . . . . 115
DepreciationLinearRate . . . . . . . . . . . . . . . . . . . 117
DepreciationNonLinearSumOfYear . . . . . . . . . . . . 119
DepreciationNonLinearLife . . . . . . . . . . . . . . . . 121
DepreciationNonLinearFactor . . . . . . . . . . . . . . . 123
-
Contents v
DepreciationNonLinearRate . . . . . . . . . . . . . . . . 125
DepreciationSum . . . . . . . . . . . . . . . . . . . . . . . 127
6.4 Investments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
InvestmentConstantPresentValue . . . . . . . . . . . . 131
InvestmentConstantFutureValue . . . . . . . . . . . . . 132
InvestmentConstantPeriodicPayment . . . . . . . . . . 133
InvestmentConstantInterestPayment . . . . . . . . . . 135
InvestmentConstantPrincipalPayment . . . . . . . . . . 137
InvestmentConstantCumulativeInterestPayment . . . 139
InvestmentConstantCumulativePrincipalPayment . . 141
InvestmentConstantNumberPeriods . . . . . . . . . . . 143
InvestmentConstantRateAll . . . . . . . . . . . . . . . . 144
InvestmentConstantRate . . . . . . . . . . . . . . . . . . 146
InvestmentVariablePresentValue . . . . . . . . . . . . . 148
InvestmentVariablePresentValueInPeriodic . . . . . . . 150
InvestmentSingleFutureValue . . . . . . . . . . . . . . . 152
InvestmentVariableInternalRateReturnAll . . . . . . . 153
InvestmentVariableInternalRateReturn . . . . . . . . . 155
InvestmentVariableInternalRateReturnInPeriodicAll . 157
InvestmentVariableInternalRateReturnInPeriodic . . . 159
InvestmentVariableInternalRateReturnModified . . . . 161
6.5 Securities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
SecurityDiscountedPrice . . . . . . . . . . . . . . . . . . 167
SecurityDiscountedRedemption . . . . . . . . . . . . . 168
SecurityDiscountedYield . . . . . . . . . . . . . . . . . . 169
SecurityDiscountedRate . . . . . . . . . . . . . . . . . . 170
TreasuryBillPrice . . . . . . . . . . . . . . . . . . . . . . . 171
TreasuryBillYield . . . . . . . . . . . . . . . . . . . . . . . 172
TreasuryBillBondEquivalent . . . . . . . . . . . . . . . . 173
SecurityMaturityPrice . . . . . . . . . . . . . . . . . . . . 174
SecurityMaturityCouponRate . . . . . . . . . . . . . . . 176
SecurityMaturityYield . . . . . . . . . . . . . . . . . . . . 178
SecurityMaturityAccruedInterest . . . . . . . . . . . . . 180
SecurityCouponNumber . . . . . . . . . . . . . . . . . . 181
SecurityCouponPreviousDate . . . . . . . . . . . . . . . 182
SecurityCouponNextDate . . . . . . . . . . . . . . . . . . 183
SecurityCouponDays . . . . . . . . . . . . . . . . . . . . 184
SecurityCouponDaysPreSettlement . . . . . . . . . . . 185
SecurityCouponDaysPostSettlement . . . . . . . . . . . 186
SecurityPeriodicPrice . . . . . . . . . . . . . . . . . . . . 187
SecurityPeriodicRedemption . . . . . . . . . . . . . . . . 189
SecurityPeriodicCouponRate . . . . . . . . . . . . . . . 191
SecurityPeriodicYieldAll . . . . . . . . . . . . . . . . . . 193
SecurityPeriodicYield . . . . . . . . . . . . . . . . . . . . 195
SecurityPeriodicAccruedInterest . . . . . . . . . . . . . 197
SecurityPeriodicDuration . . . . . . . . . . . . . . . . . . 199
-
Contents vi
SecurityPeriodicDurationModified . . . . . . . . . . . . 201
7 Distribution and Combinatoric Functions 203
Binomial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Geometric . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
HyperGeometric . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
NegativeBinomial . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Poisson . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Beta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Exponential . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
ExtremeValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Gamma . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Logistic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
LogNormal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Normal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Pareto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Triangular . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Uniform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Weibull . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
DistributionCumulative . . . . . . . . . . . . . . . . . . . . . . . 221
DistributionInverseCumulative . . . . . . . . . . . . . . . . . . . 222
DistributionDensity . . . . . . . . . . . . . . . . . . . . . . . . . . 223
DistributionInverseDensity . . . . . . . . . . . . . . . . . . . . . 224
DistributionMean . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
DistributionDeviation . . . . . . . . . . . . . . . . . . . . . . . . . 226
DistributionVariance . . . . . . . . . . . . . . . . . . . . . . . . . 227
DistributionSkewness . . . . . . . . . . . . . . . . . . . . . . . . . 228
DistributionKurtosis . . . . . . . . . . . . . . . . . . . . . . . . . 229
Combination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Factorial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Permutation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
8 Histogram Functions 233
HistogramAddObservation . . . . . . . . . . . . . . . . . . . . . 234
HistogramCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
HistogramDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
HistogramGetAverage . . . . . . . . . . . . . . . . . . . . . . . . . 237
HistogramGetBounds . . . . . . . . . . . . . . . . . . . . . . . . . 238
HistogramGetDeviation . . . . . . . . . . . . . . . . . . . . . . . . 239
HistogramGetFrequencies . . . . . . . . . . . . . . . . . . . . . . 240
HistogramGetKurtosis . . . . . . . . . . . . . . . . . . . . . . . . 241
HistogramGetObservationCount . . . . . . . . . . . . . . . . . . 242
HistogramGetSkewness . . . . . . . . . . . . . . . . . . . . . . . . 243
HistogramSetDomain . . . . . . . . . . . . . . . . . . . . . . . . . 244
-
Contents vii
9 Forecasting Functions 246
9.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
9.2 Time series forecasting . . . . . . . . . . . . . . . . . . . . . . . . 246
9.2.1 Notational conventions time series forecasting . . . . 246
forecasting::MovingAverage . . . . . . . . . . . . . . . . 249
forecasting::ExponentialSmoothing . . . . . . . . . . . 252
forecasting::ExponentialSmoothingTrend . . . . . . . . 254
forecasting::ExponentialSmoothingTrendSeasonality 256
Part II Algorithmic Capabilities 260
10 Constraint Programming Functions 260
cp::AllDifferent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
cp::BinPacking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
cp::Cardinality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
cp::Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
cp::Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
cp::Lexicographic . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
cp::ParallelSchedule . . . . . . . . . . . . . . . . . . . . . . . . . . 276
cp::Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
cp::SequentialSchedule . . . . . . . . . . . . . . . . . . . . . . . . 281
11 Scheduling Functions 284
cp::ActivityBegin . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
cp::ActivityEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
cp::ActivityLength . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
cp::ActivitySize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
cp::Alternative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
cp::BeginAtBegin . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
cp::BeginAtEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
cp::BeginBeforeBegin . . . . . . . . . . . . . . . . . . . . . . . . . 293
cp::BeginBeforeEnd . . . . . . . . . . . . . . . . . . . . . . . . . . 294
cp::BeginOfNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
cp::BeginOfPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . 296
cp::EndAtBegin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
cp::EndAtEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
cp::EndBeforeBegin . . . . . . . . . . . . . . . . . . . . . . . . . . 299
cp::EndBeforeEnd . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
cp::EndOfNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
cp::EndOfPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
cp::GroupOfNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
cp::GroupOfPrevious . . . . . . . . . . . . . . . . . . . . . . . . . 304
cp::LengthOfNext . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
-
Contents viii
cp::LengthOfPrevious . . . . . . . . . . . . . . . . . . . . . . . . . 306
cp::SizeOfNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
cp::SizeOfPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
cp::Span . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
cp::Synchronize . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
12 The gmp library 311
12.1 GMP::Benders Procedures and Functions . . . . . . . . . . . . . 312
GMP::Benders::AddFeasibilityCut . . . . . . . . . . . . . 313
GMP::Benders::AddOptimalityCut . . . . . . . . . . . . . 316
GMP::Benders::CreateMasterProblem . . . . . . . . . . . 318
GMP::Benders::CreateSubProblem . . . . . . . . . . . . . 320
GMP::Benders::UpdateSubProblem . . . . . . . . . . . . 322
12.2 GMP::Coefficient Procedures and Functions . . . . . . . . . . . 324
GMP::Coefficient::Get . . . . . . . . . . . . . . . . . . . . 325
GMP::Coefficient::GetQuadratic . . . . . . . . . . . . . . 326
GMP::Coefficient::Set . . . . . . . . . . . . . . . . . . . . . 327
GMP::Coefficient::SetMulti . . . . . . . . . . . . . . . . . 329
GMP::Coefficient::SetQuadratic . . . . . . . . . . . . . . 331
12.3 GMP::Column Procedures and Functions . . . . . . . . . . . . . 332
GMP::Column::Add . . . . . . . . . . . . . . . . . . . . . . 333
GMP::Column::Delete . . . . . . . . . . . . . . . . . . . . 334
GMP::Column::Freeze . . . . . . . . . . . . . . . . . . . . 335
GMP::Column::FreezeMulti . . . . . . . . . . . . . . . . . 336
GMP::Column::GetLowerBound . . . . . . . . . . . . . . 338
GMP::Column::GetName . . . . . . . . . . . . . . . . . . 340
GMP::Column::GetScale . . . . . . . . . . . . . . . . . . . 341
GMP::Column::GetStatus . . . . . . . . . . . . . . . . . . 342
GMP::Column::GetType . . . . . . . . . . . . . . . . . . . 343
GMP::Column::GetUpperBound . . . . . . . . . . . . . . 344
GMP::Column::SetAsObjective . . . . . . . . . . . . . . . 346
GMP::Column::SetLowerBound . . . . . . . . . . . . . . 347
GMP::Column::SetLowerBoundMulti . . . . . . . . . . . 349
GMP::Column::SetType . . . . . . . . . . . . . . . . . . . 351
GMP::Column::SetUpperBound . . . . . . . . . . . . . . 352
GMP::Column::SetUpperBoundMulti . . . . . . . . . . . 354
GMP::Column::Unfreeze . . . . . . . . . . . . . . . . . . . 356
GMP::Column::UnfreezeMulti . . . . . . . . . . . . . . . 357
12.4 GMP::Event Procedures and Functions . . . . . . . . . . . . . . . 359
GMP::Event::Create . . . . . . . . . . . . . . . . . . . . . . 360
GMP::Event::Delete . . . . . . . . . . . . . . . . . . . . . . 361
GMP::Event::Reset . . . . . . . . . . . . . . . . . . . . . . 362
GMP::Event::Set . . . . . . . . . . . . . . . . . . . . . . . . 363
12.5 GMP::Instance Procedures and Functions . . . . . . . . . . . . . 364
GMP::Instance::AddIntegerEliminationRows . . . . . . 366
GMP::Instance::CalculateSubGradient . . . . . . . . . . 369
-
Contents ix
GMP::Instance::Copy . . . . . . . . . . . . . . . . . . . . . 371
GMP::Instance::CreateDual . . . . . . . . . . . . . . . . . 372
GMP::Instance::CreateFeasibility . . . . . . . . . . . . . 375
GMP::Instance::CreateMasterMIP . . . . . . . . . . . . . 378
GMP::Instance::CreatePresolved . . . . . . . . . . . . . . 379
GMP::Instance::CreateProgressCategory . . . . . . . . . 381
GMP::Instance::CreateSolverSession . . . . . . . . . . . 382
GMP::Instance::Delete . . . . . . . . . . . . . . . . . . . . 383
GMP::Instance::DeleteIntegerEliminationRows . . . . . 384
GMP::Instance::DeleteSolverSession . . . . . . . . . . . 385
GMP::Instance::FindApproximatelyFeasibleSolution . 386
GMP::Instance::FixColumns . . . . . . . . . . . . . . . . 388
GMP::Instance::Generate . . . . . . . . . . . . . . . . . . 390
GMP::Instance::GenerateRobustCounterpart . . . . . . 391
GMP::Instance::GenerateStochasticProgram . . . . . . 393
GMP::Instance::GetBestBound . . . . . . . . . . . . . . . 395
GMP::Instance::GetColumnNumbers . . . . . . . . . . . 396
GMP::Instance::GetDirection . . . . . . . . . . . . . . . . 398
GMP::Instance::GetMathematicalProgrammingType . . 399
GMP::Instance::GetMemoryUsed . . . . . . . . . . . . . . 400
GMP::Instance::GetNumberOfColumns . . . . . . . . . 401
GMP::Instance::GetNumberOfIndicatorRows . . . . . . 402
GMP::Instance::GetNumberOfIntegerColumns . . . . . 403
GMP::Instance::GetNumberOfNonlinearColumns . . . 404
GMP::Instance::GetNumberOfNonlinearNonzeros . . . 405
GMP::Instance::GetNumberOfNonlinearRows . . . . . . 406
GMP::Instance::GetNumberOfNonzeros . . . . . . . . . 407
GMP::Instance::GetNumberOfRows . . . . . . . . . . . . 408
GMP::Instance::GetNumberOfSOS1Rows . . . . . . . . . 409
GMP::Instance::GetNumberOfSOS2Rows . . . . . . . . . 410
GMP::Instance::GetObjective . . . . . . . . . . . . . . . . 411
GMP::Instance::GetObjectiveColumnNumber . . . . . . 412
GMP::Instance::GetObjectiveRowNumber . . . . . . . . 413
GMP::Instance::GetOptionValue . . . . . . . . . . . . . . 414
GMP::Instance::GetRowNumbers . . . . . . . . . . . . . 415
GMP::Instance::GetSolver . . . . . . . . . . . . . . . . . . 417
GMP::Instance::GetSymbolicMathematicalProgram . . 418
GMP::Instance::MemoryStatistics . . . . . . . . . . . . . 419
GMP::Instance::Rename . . . . . . . . . . . . . . . . . . . 421
GMP::Instance::SetCallbackAddCut . . . . . . . . . . . . 422
GMP::Instance::SetCallbackAddLazyConstraint . . . . 423
GMP::Instance::SetCallbackBranch . . . . . . . . . . . . 425
GMP::Instance::SetCallbackHeuristic . . . . . . . . . . . 427
GMP::Instance::SetCallbackIncumbent . . . . . . . . . . 428
GMP::Instance::SetCallbackIterations . . . . . . . . . . . 430
GMP::Instance::SetCallbackNewIncumbent . . . . . . . 432
-
Contents x
GMP::Instance::SetCallbackStatusChange . . . . . . . . 433
GMP::Instance::SetCPUSecondsLimit . . . . . . . . . . . 434
GMP::Instance::SetCutoff . . . . . . . . . . . . . . . . . . 435
GMP::Instance::SetDirection . . . . . . . . . . . . . . . . 436
GMP::Instance::SetIterationLimit . . . . . . . . . . . . . 437
GMP::Instance::SetMathematicalProgrammingType . . 438
GMP::Instance::SetMemoryLimit . . . . . . . . . . . . . . 439
GMP::Instance::SetOptionValue . . . . . . . . . . . . . . 440
GMP::Instance::SetSolver . . . . . . . . . . . . . . . . . . 441
GMP::Instance::SetStartingPointSelection . . . . . . . . 442
GMP::Instance::Solve . . . . . . . . . . . . . . . . . . . . . 443
12.6 GMP::Linearization Procedures and Functions . . . . . . . . . . 444
GMP::Linearization::Add . . . . . . . . . . . . . . . . . . 445
GMP::Linearization::AddSingle . . . . . . . . . . . . . . 447
GMP::Linearization::Delete . . . . . . . . . . . . . . . . . 450
GMP::Linearization::GetDeviation . . . . . . . . . . . . . 451
GMP::Linearization::GetDeviationBound . . . . . . . . . 452
GMP::Linearization::GetLagrangeMultiplier . . . . . . . 453
GMP::Linearization::GetType . . . . . . . . . . . . . . . . 454
GMP::Linearization::GetWeight . . . . . . . . . . . . . . 455
GMP::Linearization::RemoveDeviation . . . . . . . . . . 456
GMP::Linearization::SetDeviationBound . . . . . . . . . 457
GMP::Linearization::SetType . . . . . . . . . . . . . . . . 458
GMP::Linearization::SetWeight . . . . . . . . . . . . . . . 459
12.7 GMP::ProgressWindow Procedures and Functions . . . . . . . . 460
GMP::ProgressWindow::DeleteCategory . . . . . . . . . 461
GMP::ProgressWindow::DisplayLine . . . . . . . . . . . 462
GMP::ProgressWindow::DisplayProgramStatus . . . . . 463
GMP::ProgressWindow::DisplaySolver . . . . . . . . . . 464
GMP::ProgressWindow::DisplaySolverStatus . . . . . . 465
GMP::ProgressWindow::FreezeLine . . . . . . . . . . . . 466
GMP::ProgressWindow::Transfer . . . . . . . . . . . . . 467
GMP::ProgressWindow::UnfreezeLine . . . . . . . . . . 469
12.8 GMP::QuadraticCoefficient Procedures and Functions . . . . . 470
GMP::QuadraticCoefficient::Get . . . . . . . . . . . . . . 471
GMP::QuadraticCoefficient::Set . . . . . . . . . . . . . . 472
12.9 GMP::Robust Procedures and Functions . . . . . . . . . . . . . . 473
GMP::Robust::EvaluateAdjustableVariables . . . . . . . 474
12.10 GMP::Row Procedures and Functions . . . . . . . . . . . . . . . 476
GMP::Row::Activate . . . . . . . . . . . . . . . . . . . . . 477
GMP::Row::Add . . . . . . . . . . . . . . . . . . . . . . . . 478
GMP::Row::Deactivate . . . . . . . . . . . . . . . . . . . . 479
GMP::Row::Delete . . . . . . . . . . . . . . . . . . . . . . . 480
GMP::Row::DeleteIndicatorCondition . . . . . . . . . . . 481
GMP::Row::Generate . . . . . . . . . . . . . . . . . . . . . 482
GMP::Row::GetConvex . . . . . . . . . . . . . . . . . . . . 484
-
Contents xi
GMP::Row::GetIndicatorColumn . . . . . . . . . . . . . . 485
GMP::Row::GetIndicatorCondition . . . . . . . . . . . . 486
GMP::Row::GetLeftHandSide . . . . . . . . . . . . . . . . 487
GMP::Row::GetName . . . . . . . . . . . . . . . . . . . . . 489
GMP::Row::GetRelaxationOnly . . . . . . . . . . . . . . . 490
GMP::Row::GetRightHandSide . . . . . . . . . . . . . . . 491
GMP::Row::GetScale . . . . . . . . . . . . . . . . . . . . . 493
GMP::Row::GetStatus . . . . . . . . . . . . . . . . . . . . 494
GMP::Row::GetType . . . . . . . . . . . . . . . . . . . . . 495
GMP::Row::SetConvex . . . . . . . . . . . . . . . . . . . . 496
GMP::Row::SetIndicatorCondition . . . . . . . . . . . . . 497
GMP::Row::SetLeftHandSide . . . . . . . . . . . . . . . . 498
GMP::Row::SetRelaxationOnly . . . . . . . . . . . . . . . 500
GMP::Row::SetRightHandSide . . . . . . . . . . . . . . . 501
GMP::Row::SetRightHandSideMulti . . . . . . . . . . . . 503
GMP::Row::SetType . . . . . . . . . . . . . . . . . . . . . . 505
12.11 GMP::Solution Procedures and Functions . . . . . . . . . . . . . 506
GMP::Solution::Check . . . . . . . . . . . . . . . . . . . . 508
GMP::Solution::ConstraintListing . . . . . . . . . . . . . 509
GMP::Solution::ConstructMean . . . . . . . . . . . . . . 514
GMP::Solution::Copy . . . . . . . . . . . . . . . . . . . . . 515
GMP::Solution::Count . . . . . . . . . . . . . . . . . . . . 516
GMP::Solution::Delete . . . . . . . . . . . . . . . . . . . . 517
GMP::Solution::DeleteAll . . . . . . . . . . . . . . . . . . 518
GMP::Solution::GetBestBound . . . . . . . . . . . . . . . 519
GMP::Solution::GetColumnValue . . . . . . . . . . . . . 520
GMP::Solution::GetCPUSecondsUsed . . . . . . . . . . . 521
GMP::Solution::GetDistance . . . . . . . . . . . . . . . . 522
GMP::Solution::GetFirstOrderDerivative . . . . . . . . . 523
GMP::Solution::GetIterationsUsed . . . . . . . . . . . . . 524
GMP::Solution::GetMemoryUsed . . . . . . . . . . . . . . 525
GMP::Solution::GetNodesUsed . . . . . . . . . . . . . . . 526
GMP::Solution::GetObjective . . . . . . . . . . . . . . . . 527
GMP::Solution::GetPenalizedObjective . . . . . . . . . . 528
GMP::Solution::GetProgramStatus . . . . . . . . . . . . . 529
GMP::Solution::GetRowValue . . . . . . . . . . . . . . . . 530
GMP::Solution::GetSolutionsSet . . . . . . . . . . . . . . 531
GMP::Solution::GetSolverStatus . . . . . . . . . . . . . . 532
GMP::Solution::IsDualDegenerated . . . . . . . . . . . . 533
GMP::Solution::IsInteger . . . . . . . . . . . . . . . . . . 534
GMP::Solution::IsPrimalDegenerated . . . . . . . . . . . 535
GMP::Solution::Move . . . . . . . . . . . . . . . . . . . . . 536
GMP::Solution::RandomlyGenerate . . . . . . . . . . . . 537
GMP::Solution::RetrieveFromModel . . . . . . . . . . . . 539
GMP::Solution::RetrieveFromSolverSession . . . . . . . 540
GMP::Solution::SendToModel . . . . . . . . . . . . . . . 541
-
Contents xii
GMP::Solution::SendToModelSelection . . . . . . . . . . 542
GMP::Solution::SendToSolverSession . . . . . . . . . . . 544
GMP::Solution::SetColumnValue . . . . . . . . . . . . . . 545
GMP::Solution::SetIterationCount . . . . . . . . . . . . . 547
GMP::Solution::SetMIPStartFlag . . . . . . . . . . . . . . 548
GMP::Solution::SetObjective . . . . . . . . . . . . . . . . 550
GMP::Solution::SetProgramStatus . . . . . . . . . . . . . 551
GMP::Solution::SetRowValue . . . . . . . . . . . . . . . . 552
GMP::Solution::SetSolverStatus . . . . . . . . . . . . . . 554
GMP::Solution::UpdatePenaltyWeights . . . . . . . . . . 555
12.12 GMP::Solver Procedures and Functions . . . . . . . . . . . . . . 556
GMP::Solver::GetAsynchronousSessionsLimit . . . . . 557
12.13 GMP::SolverSession Procedures and Functions . . . . . . . . . 559
GMP::SolverSession::AddBendersFeasibilityCut . . . . 560
GMP::SolverSession::AddBendersOptimalityCut . . . . 563
GMP::SolverSession::AddLinearization . . . . . . . . . . 566
GMP::SolverSession::AsynchronousExecute . . . . . . . 568
GMP::SolverSession::CreateProgressCategory . . . . . 570
GMP::SolverSession::Execute . . . . . . . . . . . . . . . . 572
GMP::SolverSession::ExecutionStatus . . . . . . . . . . . 573
GMP::SolverSession::GenerateBinaryEliminationRow . 574
GMP::SolverSession::GenerateBranchLowerBound . . . 576
GMP::SolverSession::GenerateBranchRow . . . . . . . . 577
GMP::SolverSession::GenerateBranchUpperBound . . . 578
GMP::SolverSession::GenerateCut . . . . . . . . . . . . . 579
GMP::SolverSession::GetBestBound . . . . . . . . . . . . 581
GMP::SolverSession::GetCallbackInterruptStatus . . . 582
GMP::SolverSession::GetCPUSecondsUsed . . . . . . . . 583
GMP::SolverSession::GetInstance . . . . . . . . . . . . . 584
GMP::SolverSession::GetIterationsUsed . . . . . . . . . 585
GMP::SolverSession::GetMemoryUsed . . . . . . . . . . 586
GMP::SolverSession::GetNodeNumber . . . . . . . . . . 587
GMP::SolverSession::GetNodeObjective . . . . . . . . . 588
GMP::SolverSession::GetNodesLeft . . . . . . . . . . . . 589
GMP::SolverSession::GetNodesUsed . . . . . . . . . . . 590
GMP::SolverSession::GetNumberOfBranchNodes . . . 591
GMP::SolverSession::GetObjective . . . . . . . . . . . . . 592
GMP::SolverSession::GetOptionValue . . . . . . . . . . . 593
GMP::SolverSession::GetProgramStatus . . . . . . . . . 594
GMP::SolverSession::GetSolver . . . . . . . . . . . . . . . 595
GMP::SolverSession::GetSolverStatus . . . . . . . . . . . 596
GMP::SolverSession::Interrupt . . . . . . . . . . . . . . . 597
GMP::SolverSession::RejectIncumbent . . . . . . . . . . 598
GMP::SolverSession::SetObjective . . . . . . . . . . . . . 599
GMP::SolverSession::SetOptionValue . . . . . . . . . . . 600
GMP::SolverSession::Transfer . . . . . . . . . . . . . . . 602
-
Contents xiii
GMP::SolverSession::WaitForCompletion . . . . . . . . 603
GMP::SolverSession::WaitForSingleCompletion . . . . . 604
12.14 GMP::Stochastic Procedures and Functions . . . . . . . . . . . . 605
GMP::Stochastic::AddBendersFeasibilityCut . . . . . . 606
GMP::Stochastic::AddBendersOptimalityCut . . . . . . 607
GMP::Stochastic::BendersFindFeasibilityReference . . 609
GMP::Stochastic::BendersFindReference . . . . . . . . . 610
GMP::Stochastic::CreateBendersRootproblem . . . . . 611
GMP::Stochastic::GetObjectiveBound . . . . . . . . . . . 612
GMP::Stochastic::GetRelativeWeight . . . . . . . . . . . 613
GMP::Stochastic::GetRepresentativeScenario . . . . . . 614
GMP::Stochastic::MergeSolution . . . . . . . . . . . . . . 615
GMP::Stochastic::UpdateBendersSubproblem . . . . . . 616
12.15 GMP::Tuning Procedures and Functions . . . . . . . . . . . . . . 617
GMP::Tuning::SolveSingleMPS . . . . . . . . . . . . . . . 618
GMP::Tuning::TuneMultipleMPS . . . . . . . . . . . . . . 620
GMP::Tuning::TuneSingleGMP . . . . . . . . . . . . . . . 622
Part III Model Handling 625
13 Model Query Functions 625
AttributeToString . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
CallerAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
CallerLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
CallerNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
CallerNumberOfLocations . . . . . . . . . . . . . . . . . . . . . . 631
ConstraintVariables . . . . . . . . . . . . . . . . . . . . . . . . . . 632
DeclaredSubset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
DomainIndex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
IdentifierAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . 637
IdentifierDimension . . . . . . . . . . . . . . . . . . . . . . . . . . 638
IdentifierElementRange . . . . . . . . . . . . . . . . . . . . . . . . 639
IdentifierText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
IdentifierType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 641
IdentifierUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 642
IndexRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
IsRuntimeIdentifier . . . . . . . . . . . . . . . . . . . . . . . . . . 644
ReferencedIdentifiers . . . . . . . . . . . . . . . . . . . . . . . . . 645
SectionIdentifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
VariableConstraints . . . . . . . . . . . . . . . . . . . . . . . . . . 647
-
Contents xiv
14 Model Edit Functions 648
me::AllowedAttribute . . . . . . . . . . . . . . . . . . . . . . . . . 649
me::ChangeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
me::ChangeTypeAllowed . . . . . . . . . . . . . . . . . . . . . . . 651
me::ChildTypeAllowed . . . . . . . . . . . . . . . . . . . . . . . . 652
me::Children . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 653
me::Compile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
me::Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
me::CreateLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . 656
me::Delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
me::ExportNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
me::GetAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
me::ImportLibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
me::ImportNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
me::IsRunnable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
me::Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
me::Parent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
me::Rename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
me::SetAttribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Part IV Data Management 668
15 Case management 668
CaseFileLoad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
CaseFileMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
CaseFileSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
CaseFileGetContentType . . . . . . . . . . . . . . . . . . . . . . . 673
CaseCompareIdentifier . . . . . . . . . . . . . . . . . . . . . . . . 674
CaseCreateDifferenceFile . . . . . . . . . . . . . . . . . . . . . . . 675
CaseFileGetContentType . . . . . . . . . . . . . . . . . . . . . . . 677
CaseFileSectionExists . . . . . . . . . . . . . . . . . . . . . . . . . 678
CaseFileSectionGetContentType . . . . . . . . . . . . . . . . . . 679
CaseFileSectionLoad . . . . . . . . . . . . . . . . . . . . . . . . . . 680
CaseFileSectionMerge . . . . . . . . . . . . . . . . . . . . . . . . . 681
CaseFileSectionRemove . . . . . . . . . . . . . . . . . . . . . . . . 682
CaseFileSectionSave . . . . . . . . . . . . . . . . . . . . . . . . . . 683
CaseFileURLtoElement . . . . . . . . . . . . . . . . . . . . . . . . 684
CaseFileSetCurrent . . . . . . . . . . . . . . . . . . . . . . . . . . 685
CaseCommandLoadAsActive . . . . . . . . . . . . . . . . . . . . 686
CaseCommandLoadIntoActive . . . . . . . . . . . . . . . . . . . 687
CaseCommandMergeIntoActive . . . . . . . . . . . . . . . . . . . 688
CaseCommandNew . . . . . . . . . . . . . . . . . . . . . . . . . . 689
CaseCommandSave . . . . . . . . . . . . . . . . . . . . . . . . . . 690
-
Contents xv
CaseCommandSaveAs . . . . . . . . . . . . . . . . . . . . . . . . 691
CaseDialogConfirmAndSave . . . . . . . . . . . . . . . . . . . . . 692
CaseDialogSelectForLoad . . . . . . . . . . . . . . . . . . . . . . . 693
CaseDialogSelectForSave . . . . . . . . . . . . . . . . . . . . . . . 694
CaseDialogSelectMultiple . . . . . . . . . . . . . . . . . . . . . . . 695
DataManagementExit . . . . . . . . . . . . . . . . . . . . . . . . . 696
16 Data Change Monitor Functions 697
DataChangeMonitorCreate . . . . . . . . . . . . . . . . . . . . . . 698
DataChangeMonitorDelete . . . . . . . . . . . . . . . . . . . . . . 700
DataChangeMonitorHasChanged . . . . . . . . . . . . . . . . . . 701
DataChangeMonitorReset . . . . . . . . . . . . . . . . . . . . . . 702
17 Database Functions 703
CloseDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . 704
CommitTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . 705
DirectSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 706
RollbackTransaction . . . . . . . . . . . . . . . . . . . . . . . . . 707
StartTransaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
TestDataSource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 709
TestDatabaseTable . . . . . . . . . . . . . . . . . . . . . . . . . . 710
TestDatabaseColumn . . . . . . . . . . . . . . . . . . . . . . . . . 711
GetDataSourceProperty . . . . . . . . . . . . . . . . . . . . . . . . 712
SQLNumberOfColumns . . . . . . . . . . . . . . . . . . . . . . . . 713
SQLNumberOfDrivers . . . . . . . . . . . . . . . . . . . . . . . . . 714
SQLNumberOfTables . . . . . . . . . . . . . . . . . . . . . . . . . 715
SQLNumberOfViews . . . . . . . . . . . . . . . . . . . . . . . . . . 716
SQLColumnData . . . . . . . . . . . . . . . . . . . . . . . . . . . . 717
SQLDriverName . . . . . . . . . . . . . . . . . . . . . . . . . . . . 719
SQLTableName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 720
SQLViewName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 721
SQLCreateConnectionString . . . . . . . . . . . . . . . . . . . . . 722
18 Spreadsheet Functions 724
Spreadsheet::ColumnName . . . . . . . . . . . . . . . . . . . . . 725
Spreadsheet::ColumnNumber . . . . . . . . . . . . . . . . . . . . 726
Spreadsheet::SetVisibility . . . . . . . . . . . . . . . . . . . . . . 727
Spreadsheet::SetActiveSheet . . . . . . . . . . . . . . . . . . . . . 728
Spreadsheet::SetUpdateLinksBehavior . . . . . . . . . . . . . . . 729
Spreadsheet::AssignValue . . . . . . . . . . . . . . . . . . . . . . 731
Spreadsheet::RetrieveValue . . . . . . . . . . . . . . . . . . . . . 732
Spreadsheet::AssignSet . . . . . . . . . . . . . . . . . . . . . . . . 733
Spreadsheet::RetrieveSet . . . . . . . . . . . . . . . . . . . . . . . 734
Spreadsheet::AssignParameter . . . . . . . . . . . . . . . . . . . 735
Spreadsheet::RetrieveParameter . . . . . . . . . . . . . . . . . . 737
Spreadsheet::AssignTable . . . . . . . . . . . . . . . . . . . . . . 739
Spreadsheet::RetrieveTable . . . . . . . . . . . . . . . . . . . . . 742
-
Contents xvi
Spreadsheet::ClearRange . . . . . . . . . . . . . . . . . . . . . . . 744
Spreadsheet::CopyRange . . . . . . . . . . . . . . . . . . . . . . . 745
Spreadsheet::AddNewSheet . . . . . . . . . . . . . . . . . . . . . 747
Spreadsheet::DeleteSheet . . . . . . . . . . . . . . . . . . . . . . . 748
Spreadsheet::GetAllSheets . . . . . . . . . . . . . . . . . . . . . . 749
Spreadsheet::RunMacro . . . . . . . . . . . . . . . . . . . . . . . . 750
Spreadsheet::CreateWorkbook . . . . . . . . . . . . . . . . . . . 752
Spreadsheet::SaveWorkbook . . . . . . . . . . . . . . . . . . . . . 753
Spreadsheet::CloseWorkbook . . . . . . . . . . . . . . . . . . . . 754
Spreadsheet::Print . . . . . . . . . . . . . . . . . . . . . . . . . . . 755
19 XML Functions 757
GenerateXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 758
ReadGeneratedXML . . . . . . . . . . . . . . . . . . . . . . . . . . 759
ReadXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 760
WriteXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 761
Part V User Interface Related Functions 763
20 Dialog Functions 763
DialogAsk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
DialogError . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 765
DialogGetColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 766
DialogGetDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 767
DialogGetElementByData . . . . . . . . . . . . . . . . . . . . . . . 768
DialogGetElement . . . . . . . . . . . . . . . . . . . . . . . . . . . 769
DialogGetElementByText . . . . . . . . . . . . . . . . . . . . . . . 770
DialogGetNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
DialogGetPassword . . . . . . . . . . . . . . . . . . . . . . . . . . 772
DialogGetString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 773
DialogMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 774
DialogProgress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 775
StatusMessage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
21 Page Functions 777
PageClose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
PageCopyTableToClipboard . . . . . . . . . . . . . . . . . . . . . 779
PageCopyTableToExcel . . . . . . . . . . . . . . . . . . . . . . . . 780
PageGetActive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 782
PageGetAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
PageGetChild . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 784
PageGetFocus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 785
PageGetNext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 786
PageGetNextInTreeWalk . . . . . . . . . . . . . . . . . . . . . . . 787
-
Contents xvii
PageGetParent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 788
PageGetPrevious . . . . . . . . . . . . . . . . . . . . . . . . . . . . 789
PageGetTitle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
PageGetUsedIdentifiers . . . . . . . . . . . . . . . . . . . . . . . . 791
PageOpen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
PageOpenSingle . . . . . . . . . . . . . . . . . . . . . . . . . . . . 793
PageRefreshAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
PageSetCursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 795
PageSetFocus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
PivotTableDeleteState . . . . . . . . . . . . . . . . . . . . . . . . . 797
PivotTableReloadState . . . . . . . . . . . . . . . . . . . . . . . . 798
PivotTableSaveState . . . . . . . . . . . . . . . . . . . . . . . . . . 800
PrintEndReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 802
PrintPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 803
PrintPageCount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 805
PrintStartReport . . . . . . . . . . . . . . . . . . . . . . . . . . . . 806
ShowMessageWindow . . . . . . . . . . . . . . . . . . . . . . . . . 807
ShowProgressWindow . . . . . . . . . . . . . . . . . . . . . . . . . 808
22 User colors 809
UserColorAdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 810
UserColorDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . 811
UserColorGetRGB . . . . . . . . . . . . . . . . . . . . . . . . . . . 812
UserColorModify . . . . . . . . . . . . . . . . . . . . . . . . . . . . 813
Part VI Development Support 815
23 Profiler and Debugger 815
DebuggerBreakPoint . . . . . . . . . . . . . . . . . . . . . . . . . . 816
ProfilerStart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 817
ProfilerPause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818
ProfilerContinue . . . . . . . . . . . . . . . . . . . . . . . . . . . . 819
ProfilerRestart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 820
24 Application Information 821
IdentifierGetUsedInformation . . . . . . . . . . . . . . . . . . . . 822
IdentifierMemory . . . . . . . . . . . . . . . . . . . . . . . . . . . 823
IdentifierMemoryStatistics . . . . . . . . . . . . . . . . . . . . . . 824
ListExpressionSubstitutions . . . . . . . . . . . . . . . . . . . . . 826
MemoryInUse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
MemoryStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . 828
ShowHelpTopic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 830
-
Contents xviii
Part VII System Interaction 832
25 Error Handling Functions 832
errh::Adapt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 833
errh::Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 834
errh::Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
errh::Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 836
errh::Column . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
errh::CreationTime . . . . . . . . . . . . . . . . . . . . . . . . . . 838
errh::Filename . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 839
errh::InsideCategory . . . . . . . . . . . . . . . . . . . . . . . . . . 840
errh::IsMarkedAsHandled . . . . . . . . . . . . . . . . . . . . . . 841
errh::Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
errh::Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 843
errh::MarkAsHandled . . . . . . . . . . . . . . . . . . . . . . . . . 844
errh::Multiplicity . . . . . . . . . . . . . . . . . . . . . . . . . . . . 845
errh::Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
errh::NumberOfLocations . . . . . . . . . . . . . . . . . . . . . . 847
errh::Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 848
26 Option manipulation 849
OptionGetDefaultString . . . . . . . . . . . . . . . . . . . . . . . 850
OptionGetKeywords . . . . . . . . . . . . . . . . . . . . . . . . . . 851
OptionGetString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
OptionGetValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . 853
OptionSetString . . . . . . . . . . . . . . . . . . . . . . . . . . . . 854
OptionSetValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 855
27 Licensing Functions 856
LicenseExpirationDate . . . . . . . . . . . . . . . . . . . . . . . . 857
LicenseMaintenanceExpirationDate . . . . . . . . . . . . . . . . 858
LicenseNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 859
LicenseStartDate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 860
LicenseType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 861
ProjectDeveloperMode . . . . . . . . . . . . . . . . . . . . . . . . 862
SecurityGetGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . 863
SecurityGetUsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 864
SolverGetControl . . . . . . . . . . . . . . . . . . . . . . . . . . . . 865
SolverReleaseControl . . . . . . . . . . . . . . . . . . . . . . . . . 866
28 Environment Functions 867
AimmsRevisionString . . . . . . . . . . . . . . . . . . . . . . . . . 868
EnvironmentGetString . . . . . . . . . . . . . . . . . . . . . . . . 869
EnvironmentSetString . . . . . . . . . . . . . . . . . . . . . . . . . 871
GeoFindCoordinates . . . . . . . . . . . . . . . . . . . . . . . . . . 872
-
Contents xix
TestInternetConnection . . . . . . . . . . . . . . . . . . . . . . . 874
29 Invoking actions 875
Delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 876
Execute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 877
ExitAimms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 878
OpenDocument . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 879
ScheduleAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 880
30 File and Directory Functions 881
DirectoryCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 882
DirectoryCreate . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
DirectoryDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 884
DirectoryExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 885
DirectoryGetCurrent . . . . . . . . . . . . . . . . . . . . . . . . . 886
DirectoryGetFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
DirectoryGetSubdirectories . . . . . . . . . . . . . . . . . . . . . 889
DirectoryMove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 891
DirectorySelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 892
FileAppend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 893
FileCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 894
FileDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 895
FileEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 896
FileExists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 897
FileGetSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
FileMove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 899
FilePrint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
FileRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 901
FileSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 902
FileSelectNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 903
FileTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 905
FileTouch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
FileView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 907
Part VIII Predefined Identifiers 909
31 System Settings Related Identifiers 909
AllAuthorizationLevels . . . . . . . . . . . . . . . . . . . . . . . . 910
AllAvailableCharacterEncodings . . . . . . . . . . . . . . . . . . 911
ASCIICharacterEncodings . . . . . . . . . . . . . . . . . . . . . . 912
ASCIIUnicodeCharacterEncodings . . . . . . . . . . . . . . . . . 913
UnicodeCharacterEncodings . . . . . . . . . . . . . . . . . . . . . 914
AllCharacterEncodings . . . . . . . . . . . . . . . . . . . . . . . . 915
AllColors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 918
-
Contents xx
AllIntrinsics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 919
AllKeywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 920
AllOptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 921
AllPredeclaredIdentifiers . . . . . . . . . . . . . . . . . . . . . . . 922
AllSolvers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 923
AllSymbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
ProfilerData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
CurrentAuthorizationLevel . . . . . . . . . . . . . . . . . . . . . 926
CurrentGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 927
CurrentSolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 928
CurrentUser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 929
AllAimmsStringConstantElements . . . . . . . . . . . . . . . . . 930
AimmsStringConstants . . . . . . . . . . . . . . . . . . . . . . . . 931
32 Language Related Identifiers 932
AggregationTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
AllAttributeNames . . . . . . . . . . . . . . . . . . . . . . . . . . . 935
AllBasicValues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 936
AllCaseComparisonModes . . . . . . . . . . . . . . . . . . . . . . 937
AllColumnTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 938
AllDataColumnCharacteristics . . . . . . . . . . . . . . . . . . . 939
AllDataSourceProperties . . . . . . . . . . . . . . . . . . . . . . . 940
AllDifferencingModes . . . . . . . . . . . . . . . . . . . . . . . . . 941
AllExecutionStatuses . . . . . . . . . . . . . . . . . . . . . . . . . 942
AllGMPExtensions . . . . . . . . . . . . . . . . . . . . . . . . . . . 943
AllIdentifierTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . 944
AllIsolationLevels . . . . . . . . . . . . . . . . . . . . . . . . . . . 946
AllFileAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 947
AllMathematicalProgrammingTypes . . . . . . . . . . . . . . . . 948
AllMatrixManipulationDirections . . . . . . . . . . . . . . . . . . 949
AllMatrixManipulationProgrammingTypes . . . . . . . . . . . . 950
AllProfilerTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 951
AllRowTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
AllConstraintProgrammingRowTypes . . . . . . . . . . . . . . . 953
AllMathematicalProgrammingRowTypes . . . . . . . . . . . . . 954
AllSolutionStates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 955
AllSolverInterrupts . . . . . . . . . . . . . . . . . . . . . . . . . . 956
AllStochasticGenerationModes . . . . . . . . . . . . . . . . . . . 957
AllSuffixNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 958
AllValueKeywords . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
AllViolationTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . 960
ContinueAbort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 961
DiskWindowVoid . . . . . . . . . . . . . . . . . . . . . . . . . . . . 962
Integers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 963
MaximizingMinimizing . . . . . . . . . . . . . . . . . . . . . . . . 964
MergeReplace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 965
-
Contents xxi
OnOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 966
TimeSlotCharacteristics . . . . . . . . . . . . . . . . . . . . . . . 967
YesNo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 968
33 Model Related Identifiers 969
AllAssertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 970
AllConstraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 971
AllConventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 972
AllDatabaseTables . . . . . . . . . . . . . . . . . . . . . . . . . . . 973
AllDefinedParameters . . . . . . . . . . . . . . . . . . . . . . . . . 974
AllDefinedSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 975
AllFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 976
AllFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 977
AllGMPEvents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 978
AllIdentifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 979
AllIndices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 980
AllIntegerVariables . . . . . . . . . . . . . . . . . . . . . . . . . . 981
AllMacros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 982
AllMathematicalPrograms . . . . . . . . . . . . . . . . . . . . . . 983
AllNonLinearConstraints . . . . . . . . . . . . . . . . . . . . . . . 984
AllParameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
AllProcedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 986
AllQuantities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 987
AllSections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 988
AllSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 989
AllSolverSessionCompletionObjects . . . . . . . . . . . . . . . . 990
AllSolverSessions . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
AllStochasticConstraints . . . . . . . . . . . . . . . . . . . . . . . 992
AllStochasticParameters . . . . . . . . . . . . . . . . . . . . . . . 993
AllStochasticVariables . . . . . . . . . . . . . . . . . . . . . . . . 994
AllUpdatableIdentifiers . . . . . . . . . . . . . . . . . . . . . . . . 995
AllVariables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 996
AllVariablesConstraints . . . . . . . . . . . . . . . . . . . . . . . 997
34 Execution State Related Identifiers 998
AllGeneratedMathematicalPrograms . . . . . . . . . . . . . . . . 999
AllProgressCategories . . . . . . . . . . . . . . . . . . . . . . . . . 1000
AllStochasticScenarios . . . . . . . . . . . . . . . . . . . . . . . . 1001
CurrentAutoUpdatedDefinitions . . . . . . . . . . . . . . . . . . 1002
CurrentErrorMessage . . . . . . . . . . . . . . . . . . . . . . . . . 1003
CurrentFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1004
CurrentFileName . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1005
CurrentInputs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1006
CurrentMatrixBlockSizes . . . . . . . . . . . . . . . . . . . . . . . 1007
CurrentMatrixColumnCount . . . . . . . . . . . . . . . . . . . . . 1008
CurrentMatrixRowCount . . . . . . . . . . . . . . . . . . . . . . . 1009
-
Contents xxii
CurrentPageNumber . . . . . . . . . . . . . . . . . . . . . . . . . . 1010
ODBCDateTimeFormat . . . . . . . . . . . . . . . . . . . . . . . . 1011
35 Case Management Related Identifiers 1012
AllCases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1013
AllCaseTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1015
AllDataCategories . . . . . . . . . . . . . . . . . . . . . . . . . . . 1016
AllDataFiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1017
AllDataSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1018
CurrentCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1019
CurrentCaseSelection . . . . . . . . . . . . . . . . . . . . . . . . . 1020
CurrentDataSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1021
CurrentDefaultCaseType . . . . . . . . . . . . . . . . . . . . . . . 1022
CurrentCaseFileContentType . . . . . . . . . . . . . . . . . . . . 1023
AllCaseFileContentTypes . . . . . . . . . . . . . . . . . . . . . . . 1024
CaseFileURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1025
36 Date-Time Related Identifiers 1026
AllAbbrMonths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1027
AllAbbrWeekdays . . . . . . . . . . . . . . . . . . . . . . . . . . . 1028
AllMonths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1029
AllTimeZones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1030
AllWeekdays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1031
LocaleAllAbbrMonths . . . . . . . . . . . . . . . . . . . . . . . . . 1032
LocaleAllAbbrWeekdays . . . . . . . . . . . . . . . . . . . . . . . 1033
LocaleAllMonths . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1034
LocaleAllWeekdays . . . . . . . . . . . . . . . . . . . . . . . . . . 1035
LocaleLongDateFormat . . . . . . . . . . . . . . . . . . . . . . . . 1036
LocaleShortDateFormat . . . . . . . . . . . . . . . . . . . . . . . . 1037
LocaleTimeFormat . . . . . . . . . . . . . . . . . . . . . . . . . . . 1038
LocaleTimeZoneName . . . . . . . . . . . . . . . . . . . . . . . . 1039
LocaleTimeZoneNameDST . . . . . . . . . . . . . . . . . . . . . . 1040
37 Error Handling Related Identifiers 1041
errh::PendingErrors . . . . . . . . . . . . . . . . . . . . . . . . . . 1042
errh::ErrorCodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1043
errh::AllErrorCategories . . . . . . . . . . . . . . . . . . . . . . . 1044
errh::AllErrorSeverities . . . . . . . . . . . . . . . . . . . . . . . . 1046
Part IX Suffices 1048
38 Common Suffices 1048
38.1 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1048
.dim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1049
-
Contents xxiii
.domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1050
.txt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1051
.type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1052
.unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1053
39 Horizon Suffices 1054
.past . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1055
.planning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1056
.beyond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1057
40 Variable and Constraint Suffices 1058
.Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1059
.Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1060
.Lower . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1061
.Stochastic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1062
.Upper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1063
.Violation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1064
.ExtendedConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . 1065
.ExtendedVariable . . . . . . . . . . . . . . . . . . . . . . . . . . . 1066
41 Variable Suffices 1067
.ReducedCost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1068
.Nonvar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1069
.Relax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1070
.Complement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1071
.DefinitionViolation . . . . . . . . . . . . . . . . . . . . . . . . . . 1072
.Derivative . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1073
.Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1074
.SmallestCoefficient . . . . . . . . . . . . . . . . . . . . . . . . . . 1075
.NominalCoefficient . . . . . . . . . . . . . . . . . . . . . . . . . . 1076
.LargestCoefficient . . . . . . . . . . . . . . . . . . . . . . . . . . . 1077
.SmallestValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1078
.LargestValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1079
42 Constraint Suffices 1080
.ShadowPrice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1081
.Convex . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1082
.RelaxationOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1083
.SmallestShadowPrice . . . . . . . . . . . . . . . . . . . . . . . . . 1084
.LargestShadowPrice . . . . . . . . . . . . . . . . . . . . . . . . . 1085
.SmallestRightHandSide . . . . . . . . . . . . . . . . . . . . . . . 1086
.NominalRightHandSide . . . . . . . . . . . . . . . . . . . . . . . 1087
.LargestRightHandSide . . . . . . . . . . . . . . . . . . . . . . . . 1088
-
Contents xxiv
43 Mathematical Program Suffices 1089
.bratio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1091
.cutoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1092
.domlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1093
.iterlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1094
.limrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1095
.nodlim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1096
.optca . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1097
.optcr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1098
.reslim . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1099
.tolinfrep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1100
.workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1101
.SolverStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1102
.ProgramStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1103
.SolverCalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1104
.objective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1105
.Incumbent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1106
.BestBound . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1107
.LinearObjective . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1108
.Nodes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1109
.GenTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1110
.SolutionTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1111
.Iterations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1112
.NumberOfBranches . . . . . . . . . . . . . . . . . . . . . . . . . . 1113
.NumberOfConstraints . . . . . . . . . . . . . . . . . . . . . . . . 1114
.NumberOfFails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1115
.NumberOfNonzeros . . . . . . . . . . . . . . . . . . . . . . . . . 1116
.NumberOfVariables . . . . . . . . . . . . . . . . . . . . . . . . . . 1117
.NumberOfInfeasibilities . . . . . . . . . . . . . . . . . . . . . . . 1118
.SumOfInfeasibilities . . . . . . . . . . . . . . . . . . . . . . . . . 1119
.CallbackProcedure . . . . . . . . . . . . . . . . . . . . . . . . . . 1120
.CallbackIterations . . . . . . . . . . . . . . . . . . . . . . . . . . . 1121
.CallbackStatusChange . . . . . . . . . . . . . . . . . . . . . . . . 1122
.CallbackNewIncumbent . . . . . . . . . . . . . . . . . . . . . . . 1123
.CallbackReturnStatus . . . . . . . . . . . . . . . . . . . . . . . . 1124
.CallbackAOA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1125
.CallbackAddCut . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1126
44 File Suffices 1127
.Ap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1129
.blank zeros . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1130
.case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1131
.PageNumber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1132
.PageMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1133
.PageSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1134
.PageWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1135
-
Contents xxv
.TopMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1136
.LeftMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1137
.BottomMargin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1138
.BodyCurrentColumn . . . . . . . . . . . . . . . . . . . . . . . . . 1139
.BodyCurrentRow . . . . . . . . . . . . . . . . . . . . . . . . . . . 1140
.BodySize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1141
.FooterCurrentColumn . . . . . . . . . . . . . . . . . . . . . . . . 1142
.FooterCurrentRow . . . . . . . . . . . . . . . . . . . . . . . . . . 1143
.FooterSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1144
.HeaderCurrentColumn . . . . . . . . . . . . . . . . . . . . . . . . 1145
.HeaderCurrentRow . . . . . . . . . . . . . . . . . . . . . . . . . . 1146
.HeaderSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1147
.lj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1148
.lw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1149
.nd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1150
.nj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1151
.nr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1152
.nw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1153
.nz . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1154
.sj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1155
.sw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1156
.tf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1157
.tj . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1158
.tw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1159
Part X Deprecated 1161
45 Deprecated Language Elements 1161
45.1 Deprecated keywords . . . . . . . . . . . . . . . . . . . . . . . . . 1161
The deprecated keyword abort . . . . . . . . . . . . . . 1162
The deprecated keywords yes and no . . . . . . . . . . 1162
The deprecated keyword system . . . . . . . . . . . . . 1162
45.2 Deprecated intrinsic procedures and functions . . . . . . . . . 1163
45.3 Deprecated suffixes . . . . . . . . . . . . . . . . . . . . . . . . . . 1163
46 Matrix Manipulation Functions 1166
MatrixActivateRow . . . . . . . . . . . . . . . . . . . . . . . . . . 1168
MatrixAddColumn . . . . . . . . . . . . . . . . . . . . . . . . . . . 1169
MatrixAddRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1170
MatrixDeactivateRow . . . . . . . . . . . . . . . . . . . . . . . . . 1171
MatrixFreezeColumn . . . . . . . . . . . . . . . . . . . . . . . . . 1172
MatrixGenerate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1173
MatrixModifyCoefficient . . . . . . . . . . . . . . . . . . . . . . . 1174
MatrixModifyColumnType . . . . . . . . . . . . . . . . . . . . . . 1175
-
Contents xxvi
MatrixModifyDirection . . . . . . . . . . . . . . . . . . . . . . . . 1176
MatrixModifyLeftHandSide . . . . . . . . . . . . . . . . . . . . . . 1177
MatrixModifyLowerBound . . . . . . . . . . . . . . . . . . . . . . 1178
MatrixModifyQuadraticCoefficient . . . . . . . . . . . . . . . . . 1179
MatrixModifyRightHandSide . . . . . . . . . . . . . . . . . . . . . 1180
MatrixModifyRowType . . . . . . . . . . . . . . . . . . . . . . . . 1181
MatrixModifyType . . . . . . . . . . . . . . . . . . . . . . . . . . . 1182
MatrixModifyUpperBound . . . . . . . . . . . . . . . . . . . . . . 1183
MatrixRegenerateRow . . . . . . . . . . . . . . . . . . . . . . . . . 1184
MatrixRestoreState . . . . . . . . . . . . . . . . . . . . . . . . . . 1185
MatrixSaveState . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1186
MatrixSolve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1187
MatrixUnfreezeColumn . . . . . . . . . . . . . . . . . . . . . . . . 1188
GenerateCut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1189
47 Outer Approximation Functions 1190
MasterMIPAddLinearizations . . . . . . . . . . . . . . . . . . . . 1192
MasterMIPDeleteIntegerEliminationCut . . . . . . . . . . . . . . 1193
MasterMIPDeleteLinearizations . . . . . . . . . . . . . . . . . . . 1194
MasterMIPEliminateIntegerSolution . . . . . . . . . . . . . . . . 1195
MasterMIPGetCPUTime . . . . . . . . . . . . . . . . . . . . . . . . 1196
MasterMIPGetIterationCount . . . . . . . . . . . . . . . . . . . . 1197
MasterMIPGetNumberOfColumns . . . . . . . . . . . . . . . . . 1198
MasterMIPGetNumberOfNonZeros . . . . . . . . . . . . . . . . . 1199
MasterMIPGetNumberOfRows . . . . . . . . . . . . . . . . . . . . 1200
MasterMIPGetObjectiveValue . . . . . . . . . . . . . . . . . . . . 1201
MasterMIPGetProgramStatus . . . . . . . . . . . . . . . . . . . . 1202
MasterMIPGetSolverStatus . . . . . . . . . . . . . . . . . . . . . . 1203
MasterMIPGetSumOfPenalties . . . . . . . . . . . . . . . . . . . . 1204
MasterMIPIsFeasible . . . . . . . . . . . . . . . . . . . . . . . . . . 1205
MasterMIPLinearizationCommand . . . . . . . . . . . . . . . . . 1206
MasterMIPSetCallback . . . . . . . . . . . . . . . . . . . . . . . . . 1208
MasterMIPSolve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1209
MINLPGetIncumbentObjectiveValue . . . . . . . . . . . . . . . . 1210
MINLPGetOptimizationDirection . . . . . . . . . . . . . . . . . . 1211
MINLPIncumbentIsFeasible . . . . . . . . . . . . . . . . . . . . . 1212
MINLPIncumbentSolutionHasBeenFound . . . . . . . . . . . . . 1213
MINLPSetIncumbentSolution . . . . . . . . . . . . . . . . . . . . 1214
MINLPSetIterationCount . . . . . . . . . . . . . . . . . . . . . . . 1215
MINLPSetProgramStatus . . . . . . . . . . . . . . . . . . . . . . . 1216
MINLPSolutionDelete . . . . . . . . . . . . . . . . . . . . . . . . . 1217
MINLPSolutionRetrieve . . . . . . . . . . . . . . . . . . . . . . . . 1218
MINLPSolutionSave . . . . . . . . . . . . . . . . . . . . . . . . . . 1219
NLPGetCPUTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1220
NLPGetIterationCount . . . . . . . . . . . . . . . . . . . . . . . . . 1221
NLPGetNumberOfColumns . . . . . . . . . . . . . . . . . . . . . . 1222
-
Contents xxvii
NLPGetNumberOfNonZeros . . . . . . . . . . . . . . . . . . . . . 1223
NLPGetNumberOfRows . . . . . . . . . . . . . . . . . . . . . . . . 1224
NLPGetObjectiveValue . . . . . . . . . . . . . . . . . . . . . . . . 1225
NLPGetProgramStatus . . . . . . . . . . . . . . . . . . . . . . . . . 1226
NLPGetSolverStatus . . . . . . . . . . . . . . . . . . . . . . . . . . 1227
NLPIsFeasible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1228
NLPLinearizationPointHasBeenFound . . . . . . . . . . . . . . . 1229
NLPSolutionIsInteger . . . . . . . . . . . . . . . . . . . . . . . . . 1230
NLPSolve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1231
48 Data management via a single data manager file 1232
48.1 Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1232
CaseCreate . . . . . . . . . . . . . . . . . . . . . . . . . . 1233
CaseDelete . . . . . . . . . . . . . . . . . . . . . . . . . . 1234
CaseFind . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
CaseGetChangedStatus . . . . . . . . . . . . . . . . . . . 1236
CaseGetDatasetReference . . . . . . . . . . . . . . . . . 1237
CaseGetType . . . . . . . . . . . . . . . . . . . . . . . . . 1238
CaseLoadCurrent . . . . . . . . . . . . . . . . . . . . . . . 1239
CaseLoadIntoCurrent . . . . . . . . . . . . . . . . . . . . 1241
CaseMerge . . . . . . . . . . . . . . . . . . . . . . . . . . . 1243
CaseNew . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1245
CaseSave . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1246
CaseSaveAll . . . . . . . . . . . . . . . . . . . . . . . . . . 1247
CaseSaveAs . . . . . . . . . . . . . . . . . . . . . . . . . . 1248
CaseSelect . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
CaseSelectMultiple . . . . . . . . . . . . . . . . . . . . . . 1250
CaseSelectNew . . . . . . . . . . . . . . . . . . . . . . . . 1251
CaseSetChangedStatus . . . . . . . . . . . . . . . . . . . 1252
CaseSetCurrent . . . . . . . . . . . . . . . . . . . . . . . . 1253
CaseReadFromSingleFile . . . . . . . . . . . . . . . . . . 1254
CaseWriteToSingleFile . . . . . . . . . . . . . . . . . . . 1255
48.2 Datasets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1256
DatasetCreate . . . . . . . . . . . . . . . . . . . . . . . . . 1257
DatasetDelete . . . . . . . . . . . . . . . . . . . . . . . . . 1258
DatasetFind . . . . . . . . . . . . . . . . . . . . . . . . . . 1259
DatasetGetCategory . . . . . . . . . . . . . . . . . . . . . 1260
DatasetGetChangedStatus . . . . . . . . . . . . . . . . . 1261
DatasetLoadCurrent . . . . . . . . . . . . . . . . . . . . . 1262
DatasetLoadIntoCurrent . . . . . . . . . . . . . . . . . . 1263
DatasetMerge . . . . . . . . . . . . . . . . . . . . . . . . . 1264
DatasetNew . . . . . . . . . . . . . . . . . . . . . . . . . . 1265
DatasetSave . . . . . . . . . . . . . . . . . . . . . . . . . . 1266
DatasetSaveAll . . . . . . . . . . . . . . . . . . . . . . . . 1267
DatasetSaveAs . . . . . . . . . . . . . . . . . . . . . . . . 1268
DatasetSelect . . . . . . . . . . . . . . . . . . . . . . . . . 1269
-
Contents xxviii
DatasetSelectNew . . . . . . . . . . . . . . . . . . . . . . 1270
DatasetSetChangedStatus . . . . . . . . . . . . . . . . . 1271
DatasetSetCurrent . . . . . . . . . . . . . . . . . . . . . . 1272
48.3 Data Manager files . . . . . . . . . . . . . . . . . . . . . . . . . . . 1273
CaseTypeCategories . . . . . . . . . . . . . . . . . . . . . 1274
CaseTypeContents . . . . . . . . . . . . . . . . . . . . . . 1275
DataCategoryContents . . . . . . . . . . . . . . . . . . . 1276
DataFileCopy . . . . . . . . . . . . . . . . . . . . . . . . . 1277
DataFileExists . . . . . . . . . . . . . . . . . . . . . . . . . 1278
DataFileGetAcronym . . . . . . . . . . . . . . . . . . . . 1279
DataFileGetComment . . . . . . . . . . . . . . . . . . . . 1280
DataFileGetDescription . . . . . . . . . . . . . . . . . . . 1281
DataFileGetGroup . . . . . . . . . . . . . . . . . . . . . . 1282
DataFileGetName . . . . . . . . . . . . . . . . . . . . . . . 1283
DataFileGetOwner . . . . . . . . . . . . . . . . . . . . . . 1284
DataFileGetPath . . . . . . . . . . . . . . . . . . . . . . . 1285
DataFileGetTime . . . . . . . . . . . . . . . . . . . . . . . 1286
DataFileReadPermitted . . . . . . . . . . . . . . . . . . . 1287
DataFileSetAcronym . . . . . . . . . . . . . . . . . . . . . 1288
DataFileSetComment . . . . . . . . . . . . . . . . . . . . 1289
DataFileWritePermitted . . . . . . . . . . . . . . . . . . . 1290
DataImport220 . . . . . . . . . . . . . . . . . . . . . . . . 1291
DataManagerFileNew . . . . . . . . . . . . . . . . . . . . 1292
DataManagerFileOpen . . . . . . . . . . . . . . . . . . . . 1293
DataManagerFileGetCurrent . . . . . . . . . . . . . . . . 1294
DataManagerExport . . . . . . . . . . . . . . . . . . . . . 1295
DataManagerImport . . . . . . . . . . . . . . . . . . . . . 1296
49 Deprecated AIMMS 220 Functions 1297
ListingFileCopy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1298
ListingFileDelete . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1299
Part XI Appendices 1301
Index 1301
-
Part I
Elementary Computational
Operations
-
Chapter 1
Arithmetic Functions
Aimms supports the following arithmetic functions:
� Abs
� ArcCosh
� ArcCos
� ArcSin
� ArcSinh
� ArcTanh
� ArcTan
� Ceil
� Cos
� Cosh
� Cube
� Degrees
� Div
� ErrorF
� Exp
� Floor
� Log
� Log10
� MapVal
� Max
� Min
� Mod
� Power
� Precision
� Radians
� Round
� ScalarValue
� Sign
� Sin
� Sinh
� Sqr
� Sqrt
� Tan
� Tanh
-
Chapter 1. Arithmetic Functions 3
� Trunc
� Val
-
Chapter 1. Arithmetic Functions 4
Abs
Abs(
x ! (input) numerical expression
)
Arguments:
x
A scalar numerical expression.
Return value:
The function Abs returns the absolute value of x.
Remarks:
The function Abs can be used in constraints of nonlinear mathematical
programs. However, nonlinear solvers may experience convergence
problems if the argument assumes values around 0.
See also:
Arithmetic functions are discussed in full detail in Section 6.1.4 of the
Language Reference.
-
Chapter 1. Arithmetic Functions 5
ArcCos
ArcCos(
x ! (input) numerical expression
)
Arguments:
x
A scalar numerical expression in the range [−1,1].
Return value:
The ArcCos function returns the arccosine of x in the range 0 to π radians.
Remarks:
� A run-time error results if x is outside the range [−1,1].� The function ArcCos can be used in constraints of nonlinear
mathematical programs.
See also:
The functions ArcSin, ArcTan, Cos. Arithmetic functions are discussed in
full detail in Section 6.1.4 of the Language Reference.
-
Chapter 1. Arithmetic Functions 6
ArcCosh
ArcCosh(
x ! (input) numerical expression
)
Arguments:
x
A scalar numerical expression in the range [1,∞).
Return value:
The ArcCosh function returns the inverse hyperbolic cosine of x in the
range from 0 to ∞.
Remarks:
� A run-time error results if x is outside the range [1,∞].� The function ArcCosh can be used in constraints of nonlinear
mathematical programs.
See also:
The functions ArcSinh, ArcTanh, Cosh. Arithmetic functions are discussed in
full detail in Section 6.1.4 of the Language Reference.
-
Chapter 1. Arithmetic Functions 7
ArcSin
ArcSin(
x ! (input) numerical expression
)
Arguments:
x
A scalar numerical expression in the range [−1,1].
Return value:
The ArcSin function returns the arcsine of x in the range −π/2 to π/2radians.
Remarks:
� A run-time error results if x is outside the range [−1,1].� The function ArcSin can be used in constraints of nonlinear
mathematical programs.
See also:
The functions ArcCos, ArcTan, Sin. Arithmetic functions are discussed in
full detail in Section 6.1.4 of the Language Reference.
-
Chapter 1. Arithmetic Functions 8
ArcSinh
ArcSinh(
x ! (input) numerical expression
)
Arguments:
x
A scalar numerical expression.
Return value:
The ArcSinh function returns the inverse hyperbolic sine of x in the range
from −∞ to ∞.
Remarks:
The function ArcSinh can be used in constraints of nonlinear mathematical
programs.
See also:
The functions ArcCosh, ArcTanh, Sinh. Arithmetic functions are discussed in
full detail in Section 6.1.4 of the Language Reference.