doc/en/ref_algorithm_QuantileRegression.rst

   1 ..
   2    Copyright (C) 2008-2024 EDF R&D
   3
   4    This file is part of SALOME ADAO module.
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU Lesser General Public
   8    License as published by the Free Software Foundation; either
   9    version 2.1 of the License, or (at your option) any later version.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Lesser General Public License for more details.
  15
  16    You should have received a copy of the GNU Lesser General Public
  17    License along with this library; if not, write to the Free Software
  18    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19
  20    See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21
  22    Author: Jean-Philippe Argaud, jean-philippe.argaud@edf.fr, EDF R&D
  23
  24 .. index:: single: QuantileRegression
  25 .. _section_ref_algorithm_QuantileRegression:
  26
  27 Calculation algorithm "*QuantileRegression*"
  28 --------------------------------------------
  29
  30 .. ------------------------------------ ..
  31 .. include:: snippets/Header2Algo01.rst
  32
  33 This mono-objective optimization algorithm allows to estimate the conditional
  34 quantiles of the state parameters distribution, expressed with a model of the
  35 observed variables. These are then the quantiles on the observed variables
  36 which will allow to determine the model parameters that satisfy to the
  37 quantiles conditions.
  38
  39 .. ------------------------------------ ..
  40 .. include:: snippets/Header2Algo12.rst
  41
  42 .. include:: snippets/FeaturePropLocalOptimization.rst
  43
  44 .. include:: snippets/FeaturePropDerivativeNeeded.rst
  45
  46 .. ------------------------------------ ..
  47 .. include:: snippets/Header2Algo02.rst
  48
  49 .. include:: snippets/Background.rst
  50
  51 .. include:: snippets/Observation.rst
  52
  53 .. include:: snippets/ObservationOperator.rst
  54
  55 .. ------------------------------------ ..
  56 .. include:: snippets/Header2Algo03AdOp.rst
  57
  58 .. include:: snippets/BoundsWithNone.rst
  59
  60 .. include:: snippets/CostDecrementTolerance_6.rst
  61
  62 .. include:: snippets/InitializationPoint.rst
  63
  64 .. include:: snippets/MaximumNumberOfIterations.rst
  65
  66 .. include:: snippets/Quantile.rst
  67
  68 StoreSupplementaryCalculations
  69   .. index:: single: StoreSupplementaryCalculations
  70
  71   *List of names*. This list indicates the names of the supplementary
  72   variables, that can be available during or at the end of the algorithm, if
  73   they are initially required by the user. Their availability involves,
  74   potentially, costly calculations or memory consumptions. The default is then
  75   a void list, none of these variables being calculated and stored by default
  76   (excepted the unconditional variables). The possible names are in the
  77   following list (the detailed description of each named variable is given in
  78   the following part of this specific algorithmic documentation, in the
  79   sub-section "*Information and variables available at the end of the
  80   algorithm*"): [
  81   "Analysis",
  82   "BMA",
  83   "CostFunctionJ",
  84   "CostFunctionJb",
  85   "CostFunctionJo",
  86   "CurrentIterationNumber",
  87   "CurrentState",
  88   "Innovation",
  89   "OMA",
  90   "OMB",
  91   "SimulatedObservationAtBackground",
  92   "SimulatedObservationAtCurrentState",
  93   "SimulatedObservationAtOptimum",
  94   ].
  95
  96   Example :
  97   ``{"StoreSupplementaryCalculations":["CurrentState", "Residu"]}``
  98
  99 *Tips for this algorithm:*
 100
 101     As the *"BackgroundError"* and *"ObservationError"* commands are required
 102     for ALL the calculation algorithms in the interface, you have to provide a
 103     value, even if these commands are not required for this algorithm, and will
 104     not be used. The simplest way is to give "1" as a STRING for both.
 105
 106 .. ------------------------------------ ..
 107 .. include:: snippets/Header2Algo04.rst
 108
 109 .. include:: snippets/Analysis.rst
 110
 111 .. include:: snippets/CostFunctionJ.rst
 112
 113 .. include:: snippets/CostFunctionJb.rst
 114
 115 .. include:: snippets/CostFunctionJo.rst
 116
 117 .. ------------------------------------ ..
 118 .. include:: snippets/Header2Algo05.rst
 119
 120 .. include:: snippets/Analysis.rst
 121
 122 .. include:: snippets/BMA.rst
 123
 124 .. include:: snippets/CostFunctionJ.rst
 125
 126 .. include:: snippets/CostFunctionJb.rst
 127
 128 .. include:: snippets/CostFunctionJo.rst
 129
 130 .. include:: snippets/CurrentIterationNumber.rst
 131
 132 .. include:: snippets/CurrentState.rst
 133
 134 .. include:: snippets/Innovation.rst
 135
 136 .. include:: snippets/OMA.rst
 137
 138 .. include:: snippets/OMB.rst
 139
 140 .. include:: snippets/SimulatedObservationAtBackground.rst
 141
 142 .. include:: snippets/SimulatedObservationAtCurrentState.rst
 143
 144 .. include:: snippets/SimulatedObservationAtOptimum.rst
 145
 146 .. ------------------------------------ ..
 147 .. _section_ref_algorithm_QuantileRegression_examples:
 148
 149 .. include:: snippets/Header2Algo06.rst
 150
 151 .. ------------------------------------ ..
 152 .. include:: snippets/Header2Algo07.rst
 153
 154 - [Buchinsky98]_
 155 - [Cade03]_
 156 - [Koenker00]_
 157 - [Koenker01]_
 158 - [WikipediaQR]_