src/util/rescale.c

   1 /* Copyright (c) 2007-2014 Massachusetts Institute of Technology
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining
   4  * a copy of this software and associated documentation files (the
   5  * "Software"), to deal in the Software without restriction, including
   6  * without limitation the rights to use, copy, modify, merge, publish,
   7  * distribute, sublicense, and/or sell copies of the Software, and to
   8  * permit persons to whom the Software is furnished to do so, subject to
   9  * the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be
  12  * included in all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  18  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  19  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  20  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 #include <stdlib.h>
  24 #include "nlopt-util.h"
  25
  26 /* Return a new array of length n (> 0) that gives a rescaling factor
  27    for each dimension, or NULL if out of memory, with dx being the
  28    array of nonzero initial steps in each dimension.  */
  29 double *nlopt_compute_rescaling(unsigned n, const double *dx)
  30 {
  31     double *s = (double *) malloc(sizeof(double) * n);
  32     unsigned i;
  33
  34     if (!s)
  35         return NULL;
  36     for (i = 0; i < n; ++i)
  37         s[i] = 1.0;             /* default: no rescaling */
  38     if (n == 1)
  39         return s;
  40
  41     for (i = 1; i < n && dx[i] == dx[i - 1]; ++i);
  42     if (i < n) {                /* unequal initial steps, rescale to make equal to dx[0] */
  43         for (i = 1; i < n; ++i)
  44             s[i] = dx[i] / dx[0];
  45     }
  46     return s;
  47 }
  48
  49 void nlopt_rescale(unsigned n, const double *s, const double *x, double *xs)
  50 {
  51     unsigned i;
  52     if (!s) {
  53         for (i = 0; i < n; ++i)
  54             xs[i] = x[i];
  55     } else {
  56         for (i = 0; i < n; ++i)
  57             xs[i] = x[i] / s[i];
  58     }
  59 }
  60
  61 void nlopt_unscale(unsigned n, const double *s, const double *x, double *xs)
  62 {
  63     unsigned i;
  64     if (!s) {
  65         for (i = 0; i < n; ++i)
  66             xs[i] = x[i];
  67     } else {
  68         for (i = 0; i < n; ++i)
  69             xs[i] = x[i] * s[i];
  70     }
  71 }
  72
  73 /* return a new array of length n equal to the original array
  74    x divided by the scale factors s, or NULL on a memory error */
  75 double *nlopt_new_rescaled(unsigned n, const double *s, const double *x)
  76 {
  77     double *xs = (double *) malloc(sizeof(double) * n);
  78     if (!xs)
  79         return NULL;
  80     nlopt_rescale(n, s, x, xs);
  81     return xs;
  82 }
  83
  84 /* since rescaling can flip the signs of the x components and the bounds,
  85    we may have to re-order the bounds in order to ensure that they
  86    remain in the correct order */
  87 void nlopt_reorder_bounds(unsigned n, double *lb, double *ub)
  88 {
  89     unsigned i;
  90     for (i = 0; i < n; ++i)
  91         if (lb[i] > ub[i]) {
  92             double t = lb[i];
  93             lb[i] = ub[i];
  94             ub[i] = t;
  95         }
  96 }