---

simple_error_func.cc

Go to the documentation of this file.

// SuperMix version 1.0  C++ source file
//
// Copyright (c) 1999 California Institute of Technology.
// All rights reserved.
//
// Redistribution and use in source and binary forms for noncommercial
// purposes are permitted provided that the above copyright notice and
// this paragraph are duplicated in all such forms and that any
// documentation and other materials related to such distribution and
// use acknowledge that the software was developed by California
// Institute of Technology. Redistribution and/or use in source or
// binary forms is not permitted for any commercial purpose. Use of
// this software does not include a permitted use of the Institute's
// name or trademark for any purpose.
//
// DISCLAIMER:
// THIS SOFTWARE AND/OR RELATED MATERIALS ARE PROVIDED "AS-IS" WITHOUT
// WARRANTY OF ANY KIND INCLUDING ANY WARRANTIES OF PERFORMANCE OR
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE OR PURPOSE (AS SET
// FORTH IN UCC 23212-2313) OR FOR ANY PURPOSE WHATSOEVER, FOR THE
// LICENSED PRODUCT, HOWEVER USED.  IN NO EVENT SHALL CALTECH/JPL BE
// LIABLE FOR ANY DAMAGES AND/OR COSTS, INCLUDING BUT NOT LIMITED TO
// INCIDENTAL OR CONSEQUENTIAL DAMAGES OF ANY KIND, INCLUDING ECONOMIC
// DAMAGE OR INJURY TO PROPERTY AND LOST PROFITS, REGARDLESS OF
// WHETHER CALTECH/JPL SHALL BE ADVISED, HAVE REASON TO KNOW, OR IN
// FACT SHALL KNOW OF THE POSSIBILITY.  THE USER BEARS ALL RISK
// RELATING TO QUALITY AND PERFORMANCE OF THE SOFTWARE AND/OR RELATED
// MATERIALS.

// ************************************************************************
//
// simple_error_func.cc
//
// See simple_error_func.h for more information. 
//
// 4/21/99 by John Ward
//
// Based on errfunc.cc written 7/22/98 J.Z.
//
// 9/11/00: Changed class name to error_func_parameters
// 9/8/00:  Inlined simple_error_func::vary_parameter::get(), set(). Some
//          general rearrangement of functionality.
//
// ************************************************************************

#include "simple_error_func.h"
#include "error.h"

abstract_real_parameter * error_func_parameters::vary(double min, double init, 
                                                  double max, double scale)
{
  if(min > max)
    error::fatal("min > max in error_func_parameters::vary() argument list");

  if(scale <= 0.0)
    error::fatal("Units argument <= 0 in error_func_parameters::vary()");

  // scale the min, init, and max values
  min  *= scale;
  init *= scale;
  max  *= scale;

  // increment the count and save the values in their associated vectors
  num_parms++;
  minimum.push_back(min);
  initial.push_back(init);  // this value isn't limited by min, max
  maximum.push_back(max);
  units.push_back(scale);

  // create and set the associated variable to a limited initial value
  init = limit(min, init, max);
  parms.push_back(init);    // the actual value is limited by min,max
  current.push_back(error_func_parameters::vary_parameter(init));

  // Return an abstract_real_parameter pointer to the variable
  // Note that the following funny syntax is needed.
  // The * dereferences the STL reverse_iterator rbegin(), which
  // "points" to the last element of the list.
  // The & produces a pointer to an abstract_real_parameter object.
  return(&(*current.rbegin())) ;   
}

real_vector error_func_parameters::get_parms_user()
{
  real_vector pv(size(), Index_1);

  for(int i = 1; i <= size(); i++)
    pv[i] = parms[i]/units[i];

  return(pv) ;
}

void error_func_parameters::set_parms(const real_vector & pv)
{
  // check if vector length is ok  
  int imin = pv.minindex() ;
  int imax = pv.maxindex() ;
  if(size() != imax-imin+1) {
    error::warning(
    "error_func_parameters::set_parms: length of real_vector != number of parameters") ;
  }
  
  // and store away the values (note that we will take incorrect length)
  int i = imin ;
  int j = 1;      // index into minimum, maximum, and parms vectors (Index_1)
  std::list<vary_parameter>::iterator ip ;
  for(ip=current.begin(); ip!= current.end() && i <= imax; ip++, i++, j++)
  {
    double v = limit(minimum[j], pv[i], maximum[j]);
    parms[j] = v;
    ip->set(v);
  }

  return ;
}

---

Please direct comments and corrections to supermix@submm.caltech.edu
Go to the supermix home page
Generated by 1.2.7