This file is indexed.

/usr/share/help/C/gnumeric/analysis-solver.xml is in gnumeric-doc 1.12.35-1.1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<sect1 id="sect-advanced-analysis-solver">
  <title>Solver</title>

  <para>With Gnumeric Solver you can solve linear programs.</para>

  <!-- Add a comment so we keep this picture in figures/. and its
       Makefile.am. -->
  <!-- solver-05.png -->


  <sect2 id="sect-advanced-analysis-solver-linearprog">
    <title>Introduction to Linear Programming</title>

    <para>A linear program (LP) is a problem that can be expressed as
    linear functions.  As you probably already know, a linear function
    is the one whose graph is always a straight line.  Thus each
    variable of it appears in a separate term with its coefficient.
    There must be no products or quotients of these variables.  In
    addition, the exponent of each term must be one.  No logarithmic,
    exponential, trigonometric terms are allowed.  Especially note that
    functions like ABS, IF, MAX, and MIN are not linear.  Here are a
    few examples of linear functions:</para>

    <programlisting>
    3x + y - 5z
    -3.23x + 0.33y
    -0.3x + 4y - 2z + 1.2m
    </programlisting>

    <para>The linear problem has a so called objective function which
    is to be minimized or maximized and constraints.  The objective
    function is the one whose value we would like to optimize.
    Typically, this function could determine the profit generated by
    the expected sales of the given model (maximization problem), or,
    the cost of the production in the given environment (minimization
    problem).  Anyway, on purely mathematical point of view, we could
    examine the following objective function:</para>

    <programlisting>
    Maximize 2x + 3y - z
    </programlisting>

    <para>In linear programming the variables of this functions are
    not allowed to take any values (otherwise the maximum of any
    objective function would be infinity).  The problem also has
    constraints.  The constraints are a set of linear functions and a
    set of their right hand side values (RHS).  For example, for the
    previously defined objective function we have the following
    constraints:</para>

    <programlisting>
    x + y &lt;= 5           (#1)
    3x - y + z &lt;= 9      (#2)
    x + y &gt;= 1           (#3)
    x + y + z = 4        (#4)
    x, y, z &gt;= 0         (non-negativity assumption)
    </programlisting>

    <para>This constraint set consists of three inequality constraints
    (#1-#3) and one equality constraint (#4).  Their RHS values are 5,
    9, 1, and 4.  In addition, we also have the non-negativity
    assumption.  That is, all the variables (x, y, and z) have to take
    only positive numbers.  The idea is to find the optimal values for
    the variables (x, y, and z) but also to satisfy all the given
    constraints.</para>
  </sect2>

  <sect2 id="sect-advanced-analysis-solver-modeling">
    <title>Spreadsheet Modeling</title>

    <para>To solve optimization problems with Gnumeric you have to
    type in the problem into a sheet.  A recommended way to start with
    is to allocate a separate column in the spreadsheet for each
    decision variable (in the previous example the x, y, and z) and a
    separate row for each constraint (the constraints #1-#4).  The
    coefficients of these variables should be placed into the cells
    corresponding to the allocated row and the column.  It is also
    recommended that you label the rows and the columns to make the
    sheet much more readable.  The sheet for our maximization problem
    would look like this:</para>

    <figure id="fig-linear-program-example">
      <title>Linear programming example</title>
      <screenshot>
        <mediaobject>
            <imageobject>
              <imagedata fileref="figures/solver-01.png" format="PNG" />
            </imageobject>
            <textobject>
              <phrase>An image of a worksheet with a linear programing problem.</phrase>
            </textobject>
           </mediaobject>
      </screenshot>
    </figure>

    <para>As you can see, we have put the model variables into cells
    B3:D3.  They are currently all zeros.  The cell E4 contains the
    objective function definition.  The easiest way to define it is to
    use SUMPRODUCT build-in function.  Thus in our model, we have the
    formula `=SUMPRODUCT(B3:D3,B4:D4)' in E3.</para>

    <para>The constraints are defined in rows seven to ten.  Since
    the coefficients of these functions are in columns B, C and D we
    will get the total sum of each of the constraint using the
    formula `SUMPRODUCT(B$3:D$3,Bn:Dn)' where n is the row number of
    the constraint.  For example, in E7 we have
    `=SUMPRODUCT(B$3:D$3,B7:D7)', in E8 `=SUMPRODUCT(B$3:D$3,B8:D8)'
    and so on.  The right hand side (RHS) values of the constraints
    are typed into cells G7:G10.</para>

  </sect2>

  <sect2 id="sect-advanced-analysis-solver-using">
    <title>Using Solver</title>

    <sect3 id="sect-advanced-analysis-solver-using-params">
      <title>Solver Parameters</title>

      <para>Now it is time to select `Solver...' from the `Tools' menu.
      After you have done it, the following dialog will appear:</para>

      <figure id="fig-solver-dialog-1">
        <title>The empty Solver dialog.</title>
        <screenshot>
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/solver-02.png" format="PNG" />
            </imageobject>
            <textobject>
              <phrase>An image of the solver dialog open to the "Parameters" tab.</phrase>
            </textobject>
           </mediaobject>
        </screenshot>
      </figure>

      <para>Since we have the objective function in E3 type this into
      the `Set Target Cell:' entry.  We are about to maximize this
      function, thus the radio button `Max' should be pressed on.  By
      default, the problem is assumed to be maximization problem.  The
      input variables (x, y, and z) were in cells B3:D3 so type the
      cell range into the `By Changing Cells:' entry.</para>

      <para>The model to be optimized is a linear model.  Thus, we
      should check that the check button `Linear (LP/MILP)' is pressed
      on the page `Model'.  Also make sure that the
      assume non-negative button is on, otherwise, the input variables
      can also take negative values.  There is also a check button
      `Assume Integer (Discrete)' which adds an integer constraint for
      all the input variables.  The integer optimization is
      described, however, later.</para>

      <para>A few additional options can be set too.  If you want to
      limit the number of iterations the optimization algorithm is
      allowed to take you can set the maximum number in the `Max
      iterations' entry box on page `Options'.  Similarly, you can 
      limit the maximum time the optimization is allowed to take in 
      the `Max time' entry box.  If either one of these settings is 
      exceeded during the optimization, the optimization is interrupted
      and an error dialog is displayed.</para>

      <para>Some models can be better solved if the model is scaled
      into another form before the actual optimization.  Gnumeric
      solver supports automatic scaling which can be checked on by
      using the check button on the bottom of the dialog.  Note that
      the automatic scaling does not change the model since before
      checking out the results the model is scaled back to its
      original form.</para>

    </sect3>

    <sect3 id="sect-advanced-analysis-solver-using-constraints">
      <title>Solver Constraints</title>

      <para>Now we can add the constraints.  Select the `Constraints'
      page from the top of the dialog and the following page should
      appear.</para>

      <figure id="fig-solver-add-constraint-dialog">
        <title>Add constraint dialog.</title>
        <screenshot>
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/solver-03.png" format="PNG" />
            </imageobject>
            <textobject>
              <phrase>An image of the solver dialog open to the "Constraints" tab.</phrase>
            </textobject>
           </mediaobject>
        </screenshot>
      </figure>

      <para>In this page, you can see all constraints that have been
      defined in the `Subject to the Constraints:' window.  Since none
      has been defined, this window should be empty.  Now type in the
      constraints (#1-#4) one by one.</para>

      <para>When adding constraints, the three entry boxes in the
      bottom of the dialog are used.  Put a cell name of the total
      left hand side (LHS) cell into the `Left Hand Side:' entry box.
      In our example, this would be E7 for the constraint #1, E8 for
      constraint #2, and so on.  The combo entry in the middle defines
      the type of the constraint.  It can be<![CDATA[ `≤', `=', `≥'
      ]]> ,`Int' or `Bool'.  We will explain the `Int' and `Bool' 
      constraints later. In this example, you should select <![CDATA[ 
      `≤' for constraints #1-#2, `≥' ]]>for #3, and `=' for 
      constraint #4. The last entry on the right takes the right hand 
      side values of the constraints.  For constraints #1-#4 they 
      should be G7 (5), G8 (9), G9 (1), and G10 (4) in this order.</para>

      <para>After typing a constraint press
      <mousebutton>Add</mousebutton> button, and you will be able to
      define the next one.  When you have typed in all the
      constraints, the Solver dialog should look like this:</para>

      <figure id="fig-solver-dialog-2">
        <title>The solver dialog</title>
        <screenshot>
          <mediaobject>
            <imageobject>
              <imagedata fileref="figures/solver-04.png" format="PNG" />
            </imageobject>
            <textobject>
              <phrase>An image of the solver dialog open to the
              "Constraints" tab with constraints entered.</phrase>
            </textobject>
           </mediaobject>
        </screenshot>
      </figure>

      <para>The order of the constraints does not matter.  If you want
      to change or delete a constraint click it and then press
      `Change' or `Delete' button.</para>

      <para>Note that you can also type ranges into the LHS and RHS
      entries.  For example, you could have typed D7:D8 and G7:G8
      instead of the two separate constraints.</para>

      <para>If the constraints have now been typed in correctly, we
      should check what reports we want to produce.</para>

    </sect3>

    <sect3 id="sect-advanced-analysis-solver-using-report">
      <title>Solver Reporting</title>

      <para>Select the `Reports' page from the top of the dialog and 
      you will see a checkbox named `Program'. This report gives the 
      model in its mathematical form. Program report is useful for 
      checking out the correctness of the model. It can also be useful 
      for educational purposes.</para>

    </sect3>

    <sect3 id="sect-advanced-analysis-solver-using-optimize">
      <title>Optimization</title>

      <para>After you have specified the parameters, the constraints 
      and the reporting options it is time to press the <guibutton>
      Solve</guibutton> button. If everything went ok, you will see a 
      dialog saying: `Solver found an optimal solution. All constraints 
      and optimality conditions are satisfied.'. This means that the 
      solver found an optimal solution and the optimal values are now 
      stored into the input variables.  For all models, this, however, 
      does not happen.</para>

      <para>If a feasible solution cannot be found, the solver reports
      that `A feasible solution could not be found. All specified
      constraints cannot be met simultaneously.'.</para>

      <para>If the model is unbounded, the solver reports that `The
      Target Cell value specified does not converge!  The program is
      unbounded.'.</para>

      <para>If the maximum number of iterations specified in the
      options was exceeded, the solver reports that `The maximum
      number of iterations exceeded. The optimal value could not be
      found.'.</para>

      <para>If the maximum time specified in the options was exceeded,
      the solver reports that `The maximum time exceeded. The optimal
      value could not be found in given time.'.</para>

    </sect3>

  </sect2>

  <sect2 id="sect-advanced-analysis-solver-intprog">
    <title>Integer Programming</title>

    <para>You can use the Solver tool also for integer programming
    (IP) and more generally mixed integer programming.  In integer
    programming some of the decision variables are required to take on
    integer values.  To do so, just add a constraint whose type is
    `Int'.</para>

  </sect2>

</sect1>