imp doc wiki groups imp at salilab.org | contact

algebra_macros.h

Go to the documentation of this file.

/**
 *  \file algebra_macros.h    \brief Various important macros
 *                           for implementing geometry.
 *
 *  Copyright 2007-2010 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPALGEBRA_MACROS_H
#define IMPALGEBRA_MACROS_H

#ifdef IMP_DOXYGEN
//! implement the needed namespace methods for a geometry type
/** These are
    - IMP::algebra::get_surface_area()
    - IMP::algebra::get_volume()
    - IMP::algebra::get_bounding_box()
    - output to a stream

    The name of the argument is g and the code snipets should return
    the expected value.
*/
#define IMP_VOLUME_GEOMETRY_METHODS(Name, area, volume, bounding_box)

//! implement the needed namespace methods for a geometry type
/** These are
    - IMP::algebra::get_surface_area()
    - IMP::algebra::get_volume()
    - IMP::algebra::get_bounding_box()
    - output to a stream

    The name of the argument is g and the code snipets should return
    the expected value.
*/
#define IMP_VOLUME_GEOMETRY_METHODS_D(Name, area, volume, bounding_box)

//! implement the needed namespace methods for a geometry type
/** These are
    - IMP::algebra::get_bounding_box()
    - output to a stream

    The name should not include the D.

    The name of the argument is g and the code snipets should return
    the expected value.
*/
#define IMP_LINEAR_GEOMETRY_METHODS(Name, bounding_box)

//! implement the needed namespace methods for a geometry type
/** These are
    - IMP::algebra::get_surface_area()
    - IMP::algebra::get_bounding_box()
    - output to a stream

    The name of the argument is g and the code snipets should return
    the expected value.
*/
#define IMP_AREA_GEOMETRY_METHODS(Name, area, bounding_box)

#else
#define IMP_VOLUME_GEOMETRY_METHODS(Name, area, volume, bounding_box)  \
  inline double get_surface_area(const Name &g) {                      \
    area;                                                              \
  }                                                                    \
  inline double get_volume(const Name &g) {                            \
    volume;                                                            \
  }                                                                    \
  inline BoundingBoxD<3> get_bounding_box(const Name &g) {             \
    bounding_box;                                                      \
  }                                                                    \
  IMP_OUTPUT_OPERATOR(Name)                                            \
  typedef std::vector<Name> Name##s

#define IMP_VOLUME_GEOMETRY_METHODS_D(Name, area, volume, bounding_box) \
  inline double get_surface_area(const Name##D<3> &g) {                 \
    area;                                                               \
  }                                                                     \
  inline double get_volume(const Name##D<3> &g) {                       \
    volume;                                                             \
  }                                                                     \
  template <unsigned int D>                                             \
  inline BoundingBoxD<D> get_bounding_box(const Name##D<D> &g) {        \
    bounding_box;                                                       \
  }                                                                     \
  IMP_OUTPUT_OPERATOR_D(Name##D)                                        \
  IMPALGEBRA_EXPORT_TEMPLATE(Name##D<3>);                               \
  IMP_NO_SWIG(typedef Name##D<2> Name##2D);                             \
  IMP_NO_SWIG(typedef std::vector<Name##2D> Name##2Ds);                 \
  IMP_NO_SWIG(typedef Name##D<3> Name##3D);                             \
  IMP_NO_SWIG(typedef std::vector<Name##3D> Name##3Ds);                 \
  IMP_NO_SWIG(typedef Name##D<4> Name##4D);                             \
  IMP_NO_SWIG(typedef std::vector<Name##4D> Name##4Ds)


#define IMP_LINEAR_GEOMETRY_METHODS(Name, bounding_box)                \
  inline BoundingBoxD<3> get_bounding_box(const Name &g) {             \
    bounding_box;                                                      \
  }                                                                    \
  IMP_OUTPUT_OPERATOR(Name)                                            \
  typedef std::vector<Name> Name##s

#define IMP_AREA_GEOMETRY_METHODS(Name, area, bounding_box)            \
  inline double get_area(const Name &g) {                              \
    area;                                                              \
  }                                                                    \
  inline BoundingBoxD<3> get_bounding_box(const Name &g) {             \
    bounding_box;                                                      \
  }                                                                    \
  IMP_OUTPUT_OPERATOR(Name)                                            \
  typedef std::vector<Name> Name##s

#endif

#endif  /* IMPALGEBRA_MACROS_H */

---