---

num_utility.h

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.
//
// ********************************************************************
// num_utility.h
//
// Utility declarations and definitions used by various numerical routines
//
// F. Rice 7/8/99
//
// ********************************************************************
#ifndef NUM_UTILITY_H
#define NUM_UTILITY_H

#include <functional>

// ********************************************************************
// A default norm for doubles, consistent with those for other data types.
// Returns the magnitude squared of the argument

inline double norm(double x) { return x*x; }


// ********************************************************************
// the following functional provides access to the overloaded global norm()
// functions, with overload resolution as a template. Useful as an argument
// to something which needs a norm function.
// Usage: default_norm<double> dnorm;  then say:  dnorm(x);

template <class X>
struct default_norm : public unary_function<X,double>
{
  double operator() (const X & x) const { return ::norm(x); }
};


// ********************************************************************
// Here are functions to convert a member function obj.f(x), where "obj"
// is of type "Class", to a form suitable for passing as an argument
// to something which requires a functional or a regular function. The
// resulting argument for use in such a a call would be:
//    member_function(&Class::f, obj)
// Note that the member function f() should take exactly one argument.

template <class S, class T, class A>
inline binder1st< mem_fun1_ref_t<S,T,A> > member_function(S (T::*f)(A), T obj)
{ return bind1st(mem_fun1_ref(f),obj); }

template <class S, class T, class A>
inline binder1st< const_mem_fun1_ref_t<S,T,A> > 
member_function(S (T::*f)(A) const, T obj)
{ return bind1st(mem_fun1_ref(f), obj); }


#endif /* NUM_UTILITY_H */

---

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