wxbox.h

Go to the documentation of this file.

#ifndef wxbox_h
#define wxbox_h
 
// WarpX includes
#include "wxobject.h"
 
// std includes
#include <cassert>
#include <iostream>
#include <vector>
#include <string>
 
// forward declarations
class WxCryptSet;
 
template<typename TYPE> class WxBox : public WxObject
{
public:
    WxBox() : _ndims(0)
    {
    }
 
    WxBox(unsigned ndims);
 
    WxBox(unsigned ndims, const TYPE* lower, const TYPE* upper);
 
    WxBox(unsigned ndims, const TYPE* length);
 
    WxBox(TYPE s1, TYPE e1);
    WxBox(TYPE s1, TYPE e1, TYPE s2, TYPE e2);
 
    WxBox(TYPE s1, TYPE e1, TYPE s2, TYPE e2, TYPE s3, TYPE e3);
 
    WxBox(TYPE s1, TYPE e1, TYPE s2, TYPE e2, TYPE s3, TYPE e3, TYPE s4, TYPE e4);
 
    WxBox(const WxBox<TYPE>& b);
    WxBox& operator=(const WxBox<TYPE>& b);
 
    virtual ~WxBox();
 
    virtual void setup(const WxCryptSet& wxc);
 
    void resize(const unsigned dim, const TYPE newLength);
 
    unsigned ndims() const
    {
        return _ndims;
    }
 
    TYPE lower(unsigned dim) const
    {
        return _lower[dim];
    }
 
    void lower(unsigned dim, TYPE low)
    {
        _lower[dim] = low;
        _length[dim] = _upper[dim] - _lower[dim];
    }
 
    TYPE upper(unsigned dim) const
    {
        return _upper[dim];
    }
 
    void upper(unsigned dim, TYPE upp)
    {
        _upper[dim] = upp;
        _length[dim] = _upper[dim] - _lower[dim];
    }
 
    std::pair<TYPE, TYPE> boundsPair(unsigned dim) const
    {
        return std::pair<TYPE, TYPE>(_lower[dim], _upper[dim]);
    }
 
    virtual bool isEmpty() const;
 
    virtual TYPE length(unsigned dim) const
    {
        return _length[dim];
    }
 
    TYPE area() const;
 
    TYPE size() const
    {
        return area();
    }
 
    std::string coordinateString() const;
 
    WxBox<TYPE> intersect(const WxBox<TYPE>& box) const;
 
    WxBox<TYPE> extend(const TYPE low[], const TYPE upp[]) const;
 
    WxBox<TYPE> extend(const TYPE uniformPad[]) const;
 
    WxBox<TYPE> extend(TYPE uniformPad) const;
 
    WxBox<TYPE> extDim(TYPE low, TYPE upp) const;
 
    void extrude(const WxBox& box);
 
    WxBox<TYPE> reduceDim(unsigned int newDim) const;
 
    bool operator==(const WxBox<TYPE>& b) const;
 
    bool contains(const TYPE coord[]) const;
 
    bool encloses(const WxBox<TYPE>& candidateBox) const;
 
    bool compareShape(const WxBox<TYPE>& candidateBox) const;
 
    static const int max_dims = 8;
 
protected:
    unsigned _ndims;
    TYPE _lower[max_dims], _upper[max_dims], _length[max_dims];
};
 
template<typename TYPE> bool operator==(const WxBox<TYPE>& wa, const WxBox<TYPE>& wb);
 
extern template class WxBox<int>;
extern template class WxBox<float>;
extern template class WxBox<double>;
 
#endif // wxbox_h