File size: 5,911 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
#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 OptSimplexVariable : OptVariable
    {

        #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 OptSimplexVariable class.
        /// </summary>
        public OptSimplexVariable()
        {

        }

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

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

        /// <summary>
        /// Initializes a new instance of the OptSimplexVariable 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 OptSimplexVariable(double initialGuess, double scaleFactor)
        {
            this._InitialGuess = initialGuess;
            this.ScaleFactor = scaleFactor;
        }

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

        /// <summary>
        /// Initializes a new instance of the OptSimplexVariable 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>
        public OptSimplexVariable(string name, double initialGuess, bool isFixed)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexVariable 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 OptSimplexVariable(double initialGuess, bool isFixed , double scaleFactor)
        {
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
            this.ScaleFactor = scaleFactor;
        }

        /// <summary>
        /// Initializes a new instance of the OptSimplexVariable 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 OptSimplexVariable(string name, double initialGuess, bool isFixed, double scaleFactor)
        {
            this._Name = name;
            this._InitialGuess = initialGuess;
            this._Fixed = isFixed;
            this.ScaleFactor = scaleFactor;
        }

        #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

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

    }
}