lsst::afw::geom::Functor Class Reference

Abstract base class for function objects. More...

#include <Functor.h>

Inheritance diagram for lsst::afw::geom::Functor:

Public Types
enum	{ magicSentinel = 0xdeadbeef }
typedef unsigned long	memId
	Type of the block's ID. More...
typedef memId(*	memNewCallback) (const memId cid)
	A function used to register a callback. More...
typedef memId(*	memCallback) (const Citizen *ptr)

Public Member Functions
	Functor (std::string const &name)
	Functor (Functor const &)
	Functor (Functor &&)
Functor &	operator= (Functor const &)
Functor &	operator= (Functor &&)
virtual	~Functor ()=default
virtual std::shared_ptr< Functor >	clone () const =0
virtual double	operator() (double x) const =0
virtual double	inverse (double y, double tol=1e-10, unsigned int maxiter=1000) const
virtual double	derivative (double x) const =0
std::string	repr () const
	Return a string representation of a Citizen. More...
void	markPersistent (void)
	Mark a Citizen as persistent and not destroyed until process end. More...
memId	getId () const
	Return the Citizen's ID. More...

Static Public Member Functions
static bool	hasBeenCorrupted ()
	Check all allocated blocks for corruption. More...
static memId	getNextMemId ()
	Return the memId of the next object to be allocated. More...
static int	init ()
	Called once when the memory system is being initialised. More...
Census
Provide a list of current Citizens
static int	census (int, memId startingMemId=0)
	How many active Citizens are there? More...
static void	census (std::ostream &stream, memId startingMemId=0)
	Print a list of all active Citizens to stream, sorted by ID. More...
static const std::vector< const Citizen * > *	census ()
	Return a (newly allocated) std::vector of active Citizens sorted by ID. More...
callbackIDs
Set callback Ids. The old Id is returned
static memId	setNewCallbackId (memId id)
	Call the NewCallback when block is allocated. More...
static memId	setDeleteCallbackId (memId id)
	Call the current DeleteCallback when block is deleted. More...
callbacks
Set the New/Delete callback functions; in each case the previously installed callback is returned. These callback functions return a value which is Added to the previously registered id. The default callback functions are called default{New,Delete}Callback; you may want to set a break point in these callbacks from your favourite debugger
static memNewCallback	setNewCallback (memNewCallback func)
	Set the NewCallback function. More...
static memCallback	setDeleteCallback (memCallback func)
	Set the DeleteCallback function. More...
static memCallback	setCorruptionCallback (memCallback func)
	Set the CorruptionCallback function. More...

Detailed Description

Abstract base class for function objects.

A default implementation of the inverse(...) member function is provided that computes the inverse of the function using the Newton-Raphson method. Concrete subclasses must therefore implement a derivative(...) member function. In cases where the function is analytically invertible, the inverse(...) function should be re-implemented in the subclass using the analytic expression.

Definition at line 50 of file Functor.h.

Member Typedef Documentation

memCallback

typedef memId(* lsst::daf::base::Citizen::memCallback) (const Citizen *ptr)

inherited

Definition at line 59 of file Citizen.h.

memId

typedef unsigned long lsst::daf::base::Citizen::memId

inherited

Type of the block's ID.

Definition at line 56 of file Citizen.h.

memNewCallback

typedef memId(* lsst::daf::base::Citizen::memNewCallback) (const memId cid)

inherited

A function used to register a callback.

Definition at line 58 of file Citizen.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

inherited

Enumerator
magicSentinel

Definition at line 86 of file Citizen.h.

{ magicSentinel = 0xdeadbeef }; 

Constructor & Destructor Documentation

Functor() [1/3]

lsst::afw::geom::Functor::Functor ( std::string const &  name )

explicit

Parameters

name	The name of the concrete subclass of this class. Used in the exception message from the inverse(...) member function.

Definition at line 35 of file Functor.cc.

: daf::base::Citizen(typeid(this)), _name(name) {}

Functor() [2/3]

lsst::afw::geom::Functor::Functor ( Functor const &  )

default

Functor() [3/3]

lsst::afw::geom::Functor::Functor ( Functor &&  )

default

~Functor()

virtual lsst::afw::geom::Functor::~Functor ( )

virtualdefault

Member Function Documentation

census() [1/3]

int lsst::daf::base::Citizen::census ( int  , memId  startingMemId = 0  )

staticinherited

How many active Citizens are there?

Parameters

startingMemId

Don't print Citizens with lower IDs

Definition at line 261 of file Citizen.cc.

      {
    if (startingMemId == 0) {              // easy
        ReadGuard guard(citizenLock);
        return _activeCitizens.size();
    }

    int n = 0;
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin();
         cur != _activeCitizens.end(); cur++) {
        if (cur->first->_CitizenId >= startingMemId) {
            n++;
        }
    }

    return n;    
}

census() [2/3]

void lsst::daf::base::Citizen::census ( std::ostream &  stream, memId  startingMemId = 0  )

staticinherited

Print a list of all active Citizens to stream, sorted by ID.

Parameters

stream	stream to print to
startingMemId	Don't print Citizens with lower IDs

Definition at line 284 of file Citizen.cc.

      {
    ReadGuard guard(citizenLock);

    std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census());

    for (std::vector<Citizen const *>::const_iterator citizen = leaks->begin(), end = leaks->end();
         citizen != end; ++citizen) {
        if ((*citizen)->getId() >= startingMemId) {
            stream << (*citizen)->repr() << "\n";
        }
    }
}

census() [3/3]

std::vector< dafBase::Citizen const * > const * lsst::daf::base::Citizen::census ( )

staticinherited

Return a (newly allocated) std::vector of active Citizens sorted by ID.

You are responsible for deleting it; or you can say std::unique_ptr<std::vector<Citizen const*> const> leaks(Citizen::census()); and not bother (that becomes std::unique_ptr in C++11)

Definition at line 316 of file Citizen.cc.

                                                               {
    std::vector<Citizen const*>* vec =
        new std::vector<Citizen const*>(0);
    ReadGuard guard(citizenLock);
    vec->reserve(_activeCitizens.size());

    for (table::iterator cur = _activeCitizens.begin();
         cur != _activeCitizens.end(); cur++) {
        vec->push_back(dynamic_cast<Citizen const*>(cur->first));
    }
        
    std::sort(vec->begin(), vec->end(), cmpId);

    return vec;
}

clone()

virtual std::shared_ptr<Functor> lsst::afw::geom::Functor::clone ( ) const

pure virtual

Implemented in lsst::afw::geom::LinearFunctor.

derivative()

virtual double lsst::afw::geom::Functor::derivative ( double  x ) const

pure virtual

Returns

df(x)/dx evaluated at x. This is used in the inverse(...) member function.

Implemented in lsst::afw::geom::LinearFunctor.

getId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getId ( ) const

inherited

Return the Citizen's ID.

Definition at line 218 of file Citizen.cc.

                                                {
    return _CitizenId;
}

getNextMemId()

dafBase::Citizen::memId lsst::daf::base::Citizen::getNextMemId ( )

staticinherited

Return the memId of the next object to be allocated.

Definition at line 223 of file Citizen.cc.

                                                 {
    return _nextMemId();
}

hasBeenCorrupted()

bool lsst::daf::base::Citizen::hasBeenCorrupted ( )

staticinherited

Check all allocated blocks for corruption.

Definition at line 347 of file Citizen.cc.

                                      {
    ReadGuard guard(citizenLock);
    for (table::iterator cur = _activeCitizens.begin();
         cur != _activeCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }
    for (table::iterator cur = _persistentCitizens.begin();
         cur != _persistentCitizens.end(); cur++) {
        if (cur->first->_hasBeenCorrupted()) {
            return true;
        }
    }

    return false;
}

init()

int lsst::daf::base::Citizen::init ( )

staticinherited

Called once when the memory system is being initialised.

Definition at line 208 of file Citizen.cc.

                         {
    volatile int dummy = 1;
    return dummy;
}

inverse()

double lsst::afw::geom::Functor::inverse ( double  y, double  tol = 1e-10, unsigned int  maxiter = 1000  ) const

virtual

Parameters

y	desired value of functor
tol	Convergence tolerance for the Newton-Raphson search such that abs(x_{iter} - x_{iter-1}) < tol.
maxiter	Maximum number of iterations in the N-R search.

Returns

The x value such that y = f(x).

Exceptions

lsst::pex::exceptions::OutOfRangeError	if (tol <= 0) or (tol > 1) or (maxiter < 1).
lsst::pex::exceptions::RuntimeError	if the number of N-R iterations > maxiter.

Definition at line 42 of file Functor.cc.

                                                                        {
    // Sanity checks for tol and maxiter.
    if (tol > 1 || tol <= 0) {
        throw LSST_EXCEPT(lsst::pex::exceptions::OutOfRangeError, "tol out-of-range, tol <=0 or tol > 1");
    }
    if (maxiter < 1) {
        throw LSST_EXCEPT(lsst::pex::exceptions::OutOfRangeError, "maxiter out-of-range, maxiter < 1");
    }
    // Use Newton-Raphson method to find the inverse.
    double x = y;
    for (unsigned int iter = 0; iter < maxiter; iter++) {
        double dx = y - operator()(x);
        if (std::fabs(dx) < tol) {
            return x;
        }
        x += dx / derivative(x);
    }
    throw LSST_EXCEPT(lsst::pex::exceptions::RuntimeError,
                      "max iteration count exceeded for subclass " + _name);
    return 0;
}

markPersistent()

void lsst::daf::base::Citizen::markPersistent ( void  )

inherited

Mark a Citizen as persistent and not destroyed until process end.

Definition at line 248 of file Citizen.cc.

                                        {
    WriteGuard guard(citizenLock);
    _persistentCitizens[this] = _activeCitizens[this];
    _activeCitizens.erase(this);
}

operator()()

virtual double lsst::afw::geom::Functor::operator() ( double  x ) const

pure virtual

Returns

y = f(x)

Implemented in lsst::afw::geom::LinearFunctor.

operator=() [1/2]

Functor & lsst::afw::geom::Functor::operator= ( Functor const &  )

default

operator=() [2/2]

Functor & lsst::afw::geom::Functor::operator= ( Functor &&  )

default

repr()

std::string lsst::daf::base::Citizen::repr ( ) const

inherited

Return a string representation of a Citizen.

Definition at line 239 of file Citizen.cc.

                                     {
    return boost::str(boost::format("%d: %08x %s")
                      % _CitizenId
                      % this
                      % lsst::utils::demangleType(_typeName)
                     );
}

setCorruptionCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setCorruptionCallback ( Citizen::memCallback  func )

staticinherited

Set the CorruptionCallback function.

Parameters

func	function be called when block is found to be corrupted

Definition at line 426 of file Citizen.cc.

                                                     {
    Citizen::memCallback old = _corruptionCallback;
    _corruptionCallback = func;

    return old;
}

setDeleteCallback()

dafBase::Citizen::memCallback lsst::daf::base::Citizen::setDeleteCallback ( Citizen::memCallback  func )

staticinherited

Set the DeleteCallback function.

Parameters

func	function be called when desired block is deleted

Definition at line 416 of file Citizen.cc.

      {
    Citizen::memCallback old = _deleteCallback;
    _deleteCallback = func;

    return old;
}

setDeleteCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setDeleteCallbackId ( Citizen::memId  id )

staticinherited

Call the current DeleteCallback when block is deleted.

Parameters

id	Desired ID

Definition at line 381 of file Citizen.cc.

      {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _deleteId;
    _deleteId = id;

    return oldId;
}

setNewCallback()

dafBase::Citizen::memNewCallback lsst::daf::base::Citizen::setNewCallback ( Citizen::memNewCallback  func )

staticinherited

Set the NewCallback function.

Parameters

func	The new function to be called when a designated block is allocated

Definition at line 406 of file Citizen.cc.

      {
    Citizen::memNewCallback old = _newCallback;
    _newCallback = func;

    return old;
}

setNewCallbackId()

dafBase::Citizen::memId lsst::daf::base::Citizen::setNewCallbackId ( Citizen::memId  id )

staticinherited

Call the NewCallback when block is allocated.

Parameters

id	Desired ID

Definition at line 370 of file Citizen.cc.

      {
    WriteGuard guard(citizenLock);
    Citizen::memId oldId = _newId;
    _newId = id;

    return oldId;
}

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-16-g953e39cab/include/lsst/afw/geom/Functor.h
• /home/jenkins-slave/snowflake/release/lsstsw/stack/Linux64/afw/15.0-16-g953e39cab/src/geom/Functor.cc