File size: 11,266 Bytes
b1b3bae
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
#region Copyright © 2009, De Santiago-Castillo JA. All rights reserved.

//Copyright © 2009 Jose Antonio De Santiago-Castillo 
//E-mail:JAntonioDeSantiago@gmail.com
//Web: www.DotNumerics.com
//
#endregion

using System;
using System.Collections.Generic;
using System.Text;

namespace DotNumerics.Optimization
{
    /// <summary>
    /// Represents a varaible that can be used in a simplex optimization classe.
    /// </summary>
    public class OptSimplexBoundVariable : OptBoundVariable
    {

        #region Fields

        /// <summary>
        /// The scale factor controls the internal variable size. Variable=IntVar*ScaleFactor where IntVar is the internal variable. 
        /// Try to set the ScaleFactor of the same order that the variable, with this value the internal size will be near to 1 . 
        /// The default value is 1. This value modifies the changes and accuracy of this variable. 
        /// </summary>
        private double _ScaleFactor = 1;

        #endregion


        #region Constructor

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        public OptSimplexBoundVariable()
        {

        }
        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="initialGuess">The initial guess.</param>
        public OptSimplexBoundVariable(double initialGuess)
        {
            this._InitialGuess = initialGuess;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="isFixed">Value that indicates if the variable is fixed.</param>
        public OptSimplexBoundVariable(double initialGuess, bool isFixed)
        {
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="name">The variable name.</param>
        /// <param name="initialGuess">The initial guess.</param>
        public OptSimplexBoundVariable(string name, double initialGuess)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="scaleFactor">A scale factor used to control the changes and accuracy of this variable.</param>
        public OptSimplexBoundVariable(double initialGuess, double scaleFactor)
        {
            this._InitialGuess = initialGuess;
            this.ScaleFactor = scaleFactor;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="name">The variable name.</param>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="scaleFactor">A scale factor used to control the changes and accuracy of this variable.</param>
        public OptSimplexBoundVariable(string name, double initialGuess, double scaleFactor)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
            this.ScaleFactor = scaleFactor;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="isFixed">Value that indicates if the variable is fixed.</param>
        /// <param name="scaleFactor">A scale factor used to control the changes and accuracy of this variable.</param>
        public OptSimplexBoundVariable(double initialGuess, bool isFixed, double scaleFactor)
        {
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
            this.ScaleFactor = scaleFactor;
        }
        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="name">The variable name.</param>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="isFixed">Value that indicates if the variable is fixed.</param>
        /// <param name="scaleFactor">A scale factor used to control the changes and accuracy of this variable.</param>
        public OptSimplexBoundVariable(string name, double initialGuess, bool isFixed, double scaleFactor)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
            this.ScaleFactor = scaleFactor;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="lowerBound">The lower bound.</param>
        /// <param name="upperBound">The upper bound.</param>
        public OptSimplexBoundVariable(double initialGuess, double lowerBound, double upperBound)
        {
            this._InitialGuess = initialGuess;
            this._LowerBound = lowerBound;
            this._UpperBound = upperBound;
        }

        /// <summary>
        ///  Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="name">The variable name.</param>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="lowerBound">The lower bound.</param>
        /// <param name="upperBound">The upper bound.</param>
        public OptSimplexBoundVariable(string name, double initialGuess, double lowerBound, double upperBound)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
            this._LowerBound = lowerBound;
            this._UpperBound = upperBound;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="lowerBound">The lower bound.</param>
        /// <param name="upperBound">The upper bound.</param>
        /// <param name="scaleFactor">A scale factor used to control the changes and accuracy of this variable.</param>
        public OptSimplexBoundVariable(double initialGuess, double lowerBound, double upperBound, double scaleFactor)
        {
            this._InitialGuess = initialGuess;
            this._LowerBound = lowerBound;
            this._UpperBound = upperBound;
            this.ScaleFactor = scaleFactor;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="name">The variable name.</param>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="lowerBound">The lower bound.</param>
        /// <param name="upperBound">The upper bound.</param>
        /// <param name="scaleFactor">A scale factor used to control the changes and accuracy of this variable.</param>
        public OptSimplexBoundVariable(string name, double initialGuess, double lowerBound, double upperBound, double scaleFactor)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
            this._LowerBound = lowerBound;
            this._UpperBound = upperBound;
            this.ScaleFactor = scaleFactor;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="isFixed">Value that indicates if the variable is fixed.</param>
        /// <param name="lowerBound">The lower bound.</param>
        /// <param name="upperBound">The upper bound.</param>
        public OptSimplexBoundVariable(double initialGuess, bool isFixed, double lowerBound, double upperBound)
        {
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
            this._LowerBound = lowerBound;
            this._UpperBound = upperBound;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexBoundVariable class.
        /// </summary>
        /// <param name="name">The variable name.</param>
        /// <param name="initialGuess">The initial guess.</param>
        /// <param name="isFixed">Value that indicates if the variable is fixed.</param>
        /// <param name="lowerBound">The lower bound.</param>
        /// <param name="upperBound">The upper bound.</param>
        public OptSimplexBoundVariable(string name, double initialGuess, bool isFixed, double lowerBound, double upperBound)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
            this._LowerBound = lowerBound;
            this._UpperBound = upperBound;
        }


        #endregion



        #region Properties

        /// <summary>
        /// The scale factor controls the internal variable size. Variable=IntVar*ScaleFactor where IntVar is the internal variable. 
        /// Try to set the ScaleFactor of the same order that the variable, with this value the internal size will be near to 1 . 
        /// The default value is 1. This value modifies the changes and accuracy of this variable. 
        /// </summary>
        public double ScaleFactor
        {
            get { return _ScaleFactor; }
            set
            {
                if (value <= 0)
                {
                    value = 1;
                }
                _ScaleFactor = value;
            }
        }

        #endregion

        #region Methods


        internal static OptSimplexBoundVariable[] GetClon(OptSimplexBoundVariable[] variables)
        {
            OptSimplexBoundVariable[] cloned = new OptSimplexBoundVariable[variables.Length];
            for (int i = 0; i < variables.Length; i++)
            {
                cloned[i] = variables[i].GetClon();
            }
            return cloned;
        }

        internal OptSimplexBoundVariable GetClon()
        {
            OptSimplexBoundVariable clon = new OptSimplexBoundVariable(this._Name, this._InitialGuess, this._LowerBound, this._UpperBound, this._ScaleFactor);
            clon.Fixed = this._Fixed;
            return clon;
        }

        public override string ToString()
        {
            string s = "n: " + this._Name + ", ig: " + this.InitialGuess.ToString() + ", f: " + this.Fixed.ToString() + ", l: " + this._LowerBound + ", u:" + this._UpperBound + ", s: " + this._ScaleFactor.ToString();
            return s;
        }

        #endregion

    }
}