#if !defined( POINTSET_INCLUDED ) /* Include this file only once */
#define POINTSET_INCLUDED
/*
*+
* Name:
* pointset.h
* Type:
* C include file.
* Purpose:
* Define the interface to the PointSet class.
* Invocation:
* #include "pointset.h"
* Description:
* This include file defines the interface to the PointSet class
* and provides the type definitions, function prototypes and
* macros, etc. needed to use this class.
*
* The PointSet class encapsulates sets of coordinate values
* representing points in an N-dimensional space, to which
* coordinate transformations may be applied. It also provides
* memory allocation facilities for coordinate values.
* Inheritance:
* The PointSet class inherits from the Object class.
* Attributes Over-Ridden:
* None.
* New Attributes Defined:
* Ncoord (integer)
* A read-only attribute that gives the number of coordinates
* for each point in a PointSet (i.e. the number of dimensions
* of the space in which the points reside). This value is
* determined when the PointSet is created.
* Npoint (integer)
* A read-only attribute that gives the number of points that
* can be stored in the PointSet. This value is determined when
* the PointSet is created.
* PointAccuracy (floating point)
* This stores the absolute accuracies for each axis in the PointSet.
* Methods Over-Ridden:
* Public:
* None.
*
* Protected:
* ClearAttrib
* Clear an attribute value for a PointSet.
* GetAttrib
* Get an attribute value for a PointSet.
* SetAttrib
* Set an attribute value for a PointSet.
* TestAttrib
* Test if an attribute value has been set for a PointSet.
* New Methods Defined:
* Public:
* astAppendPoints
* Append one PointSet to another.
* astBndPoints
* Find the axis bounds of the points in a PointSet.
* astGetPoints
* Get a pointer to the coordinate values associated with a PointSet.
* astPermPoints
* Permute coordinates within a PointSet.
* astSetPoints
* Associate coordinate values with a PointSet.
* astSetNpoint
* Reduce the size of a PointSet.
* astSetSubPoints
* Associate one PointSet with a subset of another.
*
* Protected:
* astGetNpoint
* Get the number of points in a PointSet.
* astGetNcoord
* Get the number of coordinate values per point from a PointSet.
* astGetPointAccuracy
* Get the curent value of the PointAcuracy attribute for an axis.
* astSetPointAccuracy
* Set a new value for the PointAcuracy attribute for an axis.
* astTestPointAccuracy
* Test the value of the PointAcuracy attribute for an axis.
* astClearPointAccuracy
* Clear the value of the PointAcuracy attribute for an axis.
* Other Class Functions:
* Public:
* astIsAPointSet
* Test class membership.
* astPointSet
* Create a PointSet.
*
* Protected:
* astCheckPointSet
* Validate class membership.
* astInitPointSet
* Initialise a PointSet.
* astInitPointSetVtab
* Initialise the virtual function table for the PointSet class.
* astLoadPointSet
* Load a PointSet.
* Macros:
* Public:
* AST__BAD
* Bad value flag for coordinate data.
*
* Protected:
* astISBAD
* Check if a value is AST__BAD or NaN.
* astISGOOD
* Check if a value is not AST__BAD or NaN.
* astISNAN
* Check if a value is NaN.
* Type Definitions:
* Public:
* AstPointSet
* PointSet object type.
*
* Protected:
* AstPointSetVtab
* PointSet virtual function table type.
* Feature Test Macros:
* astCLASS
* If the astCLASS macro is undefined, only public symbols are
* made available, otherwise protected symbols (for use in other
* class implementations) are defined. This macro also affects
* the reporting of error context information, which is only
* provided for external calls to the AST library.
* Copyright:
* Copyright (C) 1997-2006 Council for the Central Laboratory of the
* Research Councils
* Licence:
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, either
* version 3 of the License, or (at your option) any later
* version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
* Authors:
* RFWS: R.F. Warren-Smith (Starlink)
* DSB: David S. Berry (Starlink)
* History:
* 30-JAN-1996 (RFWS):
* Original version.
* 27-SEP-1996 (RFWS):
* Added external interface and I/O facilities.
* 8-JAN-2003 (DSB):
* Added protected astInitPointSetVtab method.
* 2-NOV-2004 (DSB):
* Added PointAccuracy attribute.
*-
*/
/* Include files. */
/* ============== */
/* Configuration results. */
/* ---------------------- */
#if HAVE_CONFIG_H
#include <config.h>
#endif
/* Interface definitions. */
/* ---------------------- */
#include "object.h" /* Base Object class */
/* C header files. */
/* --------------- */
#include <float.h>
#if defined(astCLASS) /* Protected */
#include <stddef.h>
#include <math.h>
#if !HAVE_DECL_ISNAN
# if HAVE_ISNAN
/* Seems that math.h does not include a prototype for isnan etc */
int isnan( double );
# else
/* isnan is not available prior to C99 so define
alternative macros Note multiple evaluations of "x" in these
macros!!! */
# define isnan(x) ((x) != (x))
# endif
#endif
#if !HAVE_DECL_ISFINITE
# if HAVE_ISFINITE
/* Seems that math.h does not include a prototype for isfinite */
int isfinite( double );
# else
/* isfinite is not available prior to C99 so define
alternative macros. Note multiple evaluations of "x" in these
macros!!! */
# define isfinite(x) (!isnan(x) && ((x) != (1.0/0.0)) && ((x) != (-1.0/0.0)))
# endif
#endif
#endif
/* Macros. */
/* ======= */
#if defined(astCLASS) || defined(astFORTRAN77)
#define STATUS_PTR status
#else
#define STATUS_PTR astGetStatusPtr
#endif
/*
*+
* Name:
* AST__BAD
* Type:
* Public macro.
* Purpose:
* Bad value flag for coordinate data.
* Synopsis:
* #include "pointset.h"
* const double AST__BAD
* Class Membership:
* Defined by the PointSet class.
* Description:
* This macro expands to a const double value that is used to flag
* coordinate values that are "bad" (i.e. undefined or
* meaningless). Classes that implement coordinate transformations
* should test coordinate values against this value, and
* appropriately propagate bad values to their output.
*-
*/
/* Define AST__BAD to be the most negative (normalised) double
value. */
#define AST__BAD (-(DBL_MAX))
/*
*+
* Name:
* AST__NAN
* Type:
* Public macro.
* Purpose:
* A value representing the double precision IEEE NaN value.
* Synopsis:
* #include "pointset.h"
* const double AST__NAN
* Class Membership:
* Defined by the PointSet class.
* Description:
* This macro expands to a const double value that is used to indicate
* that a IEEE NaN value should be used. Note, AST__NAN itself is a finite
* double precision floating point value a little below the maximum
* allowed value for a double. This value can be used as flag to
* indicate that the corresponding IEEE NaN value should be used in its
* place.
*-
*/
#define AST__NAN (-(0.95*DBL_MAX))
/*
*+
* Name:
* AST__NANF
* Type:
* Public macro.
* Purpose:
* A value representing the single precision IEEE NaN value.
* Synopsis:
* #include "pointset.h"
* const double AST__NANF
* Class Membership:
* Defined by the PointSet class.
* Description:
* This macro expands to a const float value that is used to indicate
* that a IEEE NaN value should be used. Note, AST__NANF itself is a finite
* single precision floating point value a little below the maximum
* allowed value for a float. This value can be used as flag to
* indicate that the corresponding IEEE NaN value should be used in its
* place.
*-
*/
#define AST__NANF ((float)-(0.95*FLT_MAX))
#if defined(astCLASS) /* Protected */
/*
*+
* Name:
* astISNAN
* Type:
* Protected macro.
* Purpose:
* Test if a double is NaN.
* Synopsis:
* #include "pointset.h"
* astISNAN(value)
* Class Membership:
* Defined by the PointSet class.
* Description:
* This macro expands to a integer valued expression which is zero
* if and only if the supplied value equals NaN ("Not a Number").
* Parameters:
* value
* The value to be tested. This should be a double.
* Examples:
* if( astISNAN(x) ) x = AST__BAD;
* If "x" is NaN replace it with AST__BAD.
* Notes:
* - To avoid problems with some compilers, you should not leave
* any white space around the macro arguments.
* - On some system it is possible that the supplied macro argument
* "x" may be evaluated multiple times. Therefore the evaluation of "x"
* should have no side effects.
*-
*/
#define astISNAN(value) isnan(value)
/*
*+
* Name:
* astISFINITE
* Type:
* Protected macro.
* Purpose:
* Test if a double is neither NaN nor Inf.
* Synopsis:
* #include "pointset.h"
* astISFINITE(value)
* Class Membership:
* Defined by the PointSet class.
* Description:
* This macro expands to a integer valued expression which is zero
* if and only if the supplied value equals NaN ("Not a Number") or Inf.
* Parameters:
* value
* The value to be tested. This should be a double.
* Examples:
* if( !astISFINITE(x) ) x = AST__BAD;
* If "x" is NaN or Inf replace it with AST__BAD.
* Notes:
* - To avoid problems with some compilers, you should not leave
* any white space around the macro arguments.
* - On some system it is possible that the supplied macro argument
* "x" may be evaluated multiple times. Therefore the evaluation of "x"
* should have no side effects.
*-
*/
#define astISFINITE(value) isfinite(value)
/*
*+
* Name:
* astISGOOD
* Type:
* Protected macro.
* Purpose:
* Test if a double is neither AST__BAD, NaN or Inf.
* Synopsis:
* #include "pointset.h"
* astISGOOD(value)
* Class Membership:
* Defined by the PointSet class.
* Description:
* This macro expands to a integer valued expression which is zero
* if and only if the supplied value equals AST__BAD or is NaN ("Not a
* Number") or "Inf".
* Parameters:
* value
* The value to be tested. This should be a double.
* Examples:
* if( astISGOOD(x) ) y = x;
* Checks that "x" is usable before assigning it to y.
* Notes:
* - To avoid problems with some compilers, you should not leave
* any white space around the macro arguments.
* - On some system it is possible that the supplied macro argument
* "x" may be evaluated multiple times. Therefore the evaluation of "x"
* should have no side effects.
*-
*/
#define astISGOOD(value) ( (value) != AST__BAD && astISFINITE(value) )
/*
*+
* Name:
* astISBAD
* Type:
* Protected macro.
* Purpose:
* Test if a double is either AST__BAD, NaN, or Inf.
* Synopsis:
* #include "pointset.h"
* astISBAD(value)
* Class Membership:
* Defined by the PointSet class.
* Description:
* This macro expands to a integer valued expression which is non-zero
* if and only if the supplied value equals AST__BAD or is NaN ("Not a
* Number"), or is Inf.
* Parameters:
* value
* The value to be tested. This should be a double.
* Examples:
* if( astISBAD(x) ) astError( ... );
* Reports an error if "x" is bad.
* Notes:
* - To avoid problems with some compilers, you should not leave
* any white space around the macro arguments.
* - On some system it is possible that the supplied macro argument
* "x" may be evaluated multiple times. Therefore the evaluation of "x"
* should have no side effects.
*-
*/
#define astISBAD(value) ( (value) == AST__BAD || !astISFINITE(value))
#endif
/* Define a dummy __attribute__ macro for use on non-GNU compilers. */
#ifndef __GNUC__
# define __attribute__(x) /*NOTHING*/
#endif
/* Type Definitions. */
/* ================= */
/* PointSet structure. */
/* ------------------- */
/* This structure contains all information that is unique to each object in
the class (e.g. its instance variables). */
typedef struct AstPointSet {
/* Attributes inherited from the parent class. */
AstObject object; /* Parent class structure */
/* Attributes specific to objects in this class. */
double **ptr; /* Pointer to array of pointers to values */
double *values; /* Pointer to array of coordinate values */
int ncoord; /* Number of coordinate values per point */
int npoint; /* Number of points */
double *acc; /* Axis accuracies */
} AstPointSet;
/* Virtual function table. */
/* ----------------------- */
/* This table contains all information that is the same for all
objects in the class (e.g. pointers to its virtual functions). */
#if defined(astCLASS) /* Protected */
typedef struct AstPointSetVtab {
/* Properties (e.g. methods) inherited from the parent class. */
AstObjectVtab object_vtab; /* Parent class virtual function table */
/* A Unique identifier to determine class membership. */
AstClassIdentifier id;
/* Properties (e.g. methods) specific to this class. */
AstPointSet *(* AppendPoints)( AstPointSet *, AstPointSet *, int * );
double **(* GetPoints)( AstPointSet *, int * );
int (* GetNcoord)( const AstPointSet *, int * );
int (* GetNpoint)( const AstPointSet *, int * );
void (* BndPoints)( AstPointSet *, double *, double *, int * );
void (* PermPoints)( AstPointSet *, int, const int[], int * );
void (* SetNpoint)( AstPointSet *, int, int * );
void (* SetPoints)( AstPointSet *, double **, int * );
void (* SetSubPoints)( AstPointSet *, int, int, AstPointSet *, int * );
int (* ReplaceNaN)( AstPointSet *, int * );
double (* GetPointAccuracy)( AstPointSet *, int, int * );
int (* TestPointAccuracy)( AstPointSet *, int, int * );
void (* ClearPointAccuracy)( AstPointSet *, int, int * );
void (* SetPointAccuracy)( AstPointSet *, int, double, int * );
} AstPointSetVtab;
#if defined(THREAD_SAFE)
/* Define a structure holding all data items that are global within this
class. */
typedef struct AstPointSetGlobals {
AstPointSetVtab Class_Vtab;
int Class_Init;
char GetAttrib_Buff[ 101 ];
} AstPointSetGlobals;
#endif
#endif
/* Function prototypes. */
/* ==================== */
/* Prototypes for standard class functions. */
/* ---------------------------------------- */
astPROTO_CHECK(PointSet) /* Check class membership */
astPROTO_ISA(PointSet) /* Test class membership */
/* Constructor. */
#if defined(astCLASS) /* Protected. */
AstPointSet *astPointSet_( int, int, const char *, int *, ...);
#else
AstPointSet *astPointSetId_( int, int, const char *, ... )__attribute__((format(printf,3,4)));
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
AstPointSet *astInitPointSet_( void *, size_t, int, AstPointSetVtab *,
const char *, int, int, int * );
/* Vtab initialiser. */
void astInitPointSetVtab_( AstPointSetVtab *, const char *, int * );
/* Loader. */
AstPointSet *astLoadPointSet_( void *, size_t, AstPointSetVtab *,
const char *, AstChannel *, int * );
/* Thread-safe initialiser for all global data used by this module. */
#if defined(THREAD_SAFE)
void astInitPointSetGlobals_( AstPointSetGlobals * );
#endif
#endif
/* Prototypes for member functions. */
/* -------------------------------- */
double **astGetPoints_( AstPointSet *, int * );
void astPermPoints_( AstPointSet *, int, const int[], int * );
void astSetPoints_( AstPointSet *, double **, int * );
void astSetNpoint_( AstPointSet *, int, int * );
void astSetSubPoints_( AstPointSet *, int, int, AstPointSet *, int * );
AstPointSet *astAppendPoints_( AstPointSet *, AstPointSet *, int * );
void astBndPoints_( AstPointSet *, double *, double *, int * );
int astReplaceNaN_( AstPointSet *, int * );
# if defined(astCLASS) /* Protected */
int astGetNcoord_( const AstPointSet *, int * );
int astGetNpoint_( const AstPointSet *, int * );
double astGetPointAccuracy_( AstPointSet *, int, int * );
int astTestPointAccuracy_( AstPointSet *, int, int * );
void astClearPointAccuracy_( AstPointSet *, int, int * );
void astSetPointAccuracy_( AstPointSet *, int, double, int * );
double astCheckNaN_( double );
float astCheckNaNF_( float );
#endif
/* Function interfaces. */
/* ==================== */
/* These macros are wrap-ups for the functions defined by this class
to make them easier to invoke (e.g. to avoid type mis-matches when
passing pointers to objects from derived classes). */
/* Interfaces to standard class functions. */
/* --------------------------------------- */
/* Some of these functions provide validation, so we cannot use them
to validate their own arguments. We must use a cast when passing
object pointers (so that they can accept objects from derived
classes). */
/* Check class membership. */
#define astCheckPointSet(this) astINVOKE_CHECK(PointSet,this,0)
#define astVerifyPointSet(this) astINVOKE_CHECK(PointSet,this,1)
/* Test class membership. */
#define astIsAPointSet(this) astINVOKE_ISA(PointSet,this)
/* Constructor. */
#if defined(astCLASS) /* Protected. */
#define astPointSet astINVOKE(F,astPointSet_)
#else
#define astPointSet astINVOKE(F,astPointSetId_)
#endif
#if defined(astCLASS) /* Protected */
/* Initialiser. */
#define astInitPointSet(mem,size,init,vtab,name,npoint,ncoord) \
astINVOKE(O,astInitPointSet_(mem,size,init,vtab,name,npoint,ncoord,STATUS_PTR))
/* Vtab Initialiser. */
#define astInitPointSetVtab(vtab,name) astINVOKE(V,astInitPointSetVtab_(vtab,name,STATUS_PTR))
/* Loader. */
#define astLoadPointSet(mem,size,vtab,name,channel) \
astINVOKE(O,astLoadPointSet_(mem,size,vtab,name,astCheckChannel(channel),STATUS_PTR))
#endif
/* Interfaces to public member functions. */
/* -------------------------------------- */
/* Here we make use of astCheckPointSet to validate PointSet pointers
before use. This provides a contextual error report if a pointer
to the wrong sort of Object is supplied. */
#define astGetPoints(this) \
astINVOKE(V,astGetPoints_(astCheckPointSet(this),STATUS_PTR))
#define astPermPoints(this,forward,perm) \
astINVOKE(V,astPermPoints_(astCheckPointSet(this),forward,perm,STATUS_PTR))
#define astSetPoints(this,ptr) \
astINVOKE(V,astSetPoints_(astCheckPointSet(this),ptr,STATUS_PTR))
#define astSetNpoint(this,np) \
astINVOKE(V,astSetNpoint_(astCheckPointSet(this),np,STATUS_PTR))
#define astSetSubPoints(point1,point,coord,point2) \
astINVOKE(V,astSetSubPoints_(astCheckPointSet(point1),point,coord,astCheckPointSet(point2),STATUS_PTR))
#define astAppendPoints(this,that) \
astINVOKE(O,astAppendPoints_(astCheckPointSet(this),astCheckPointSet(that),STATUS_PTR))
#define astBndPoints(this,lbnd,ubnd) \
astINVOKE(V,astBndPoints_(astCheckPointSet(this),lbnd,ubnd,STATUS_PTR))
#define astReplaceNaN(this) \
astINVOKE(V,astReplaceNaN_(astCheckPointSet(this),STATUS_PTR))
#if defined(astCLASS) /* Protected */
#define astGetNpoint(this) \
astINVOKE(V,astGetNpoint_(astCheckPointSet(this),STATUS_PTR))
#define astGetNcoord(this) \
astINVOKE(V,astGetNcoord_(astCheckPointSet(this),STATUS_PTR))
#define astClearPointAccuracy(this,axis) \
astINVOKE(V,astClearPointAccuracy_(astCheckPointSet(this),axis,STATUS_PTR))
#define astGetPointAccuracy(this,axis) \
astINVOKE(V,astGetPointAccuracy_(astCheckPointSet(this),axis,STATUS_PTR))
#define astSetPointAccuracy(this,axis,value) \
astINVOKE(V,astSetPointAccuracy_(astCheckPointSet(this),axis,value,STATUS_PTR))
#define astTestPointAccuracy(this,axis) \
astINVOKE(V,astTestPointAccuracy_(astCheckPointSet(this),axis,STATUS_PTR))
#define astCheckNaNF(value) astCheckNaNF_(value)
#define astCheckNaN(value) astCheckNaN_(value)
#endif
#endif