IntersectionMatrix.h

/**********************************************************************
 *
 * GEOS - Geometry Engine Open Source
 * http://geos.osgeo.org
 *
 * Copyright (C) 2006 Refractions Research Inc.
 *
 * This is free software; you can redistribute and/or modify it under
 * the terms of the GNU Lesser General Public Licence as published
 * by the Free Software Foundation.
 * See the COPYING file for more information.
 *
 **********************************************************************
 *
 * Last port: geom/IntersectionMatrix.java rev. 1.18
 *
 **********************************************************************/
 
#pragma once
 
#include <geos/geom/Location.h>
 
#include <geos/export.h>
#include <array>
#include <string>
 
namespace geos {
namespace geom { // geos::geom
 
class GEOS_DLL IntersectionMatrix {
 
public:
 
    IntersectionMatrix();
 
    IntersectionMatrix(const std::string& elements);
 
    IntersectionMatrix(const IntersectionMatrix& other);
 
    bool matches(const std::string& requiredDimensionSymbols) const;
 
    static bool matches(int actualDimensionValue,
                        char requiredDimensionSymbol);
 
    static bool matches(const std::string& actualDimensionSymbols,
                        const std::string& requiredDimensionSymbols);
 
    void add(IntersectionMatrix* other);
 
    void set(Location row, Location column, int dimensionValue);
 
    void set(const std::string& dimensionSymbols);
 
    void setAtLeast(Location row, Location column, int minimumDimensionValue);
 
    void setAtLeastIfValid(Location row, Location column, int minimumDimensionValue);
 
    void setAtLeast(std::string minimumDimensionSymbols);
 
    void setAll(int dimensionValue);
 
    int get(geom::Location row, geom::Location column) const {
        return matrix[static_cast<size_t>(row)][static_cast<size_t>(column)];
    }
 
    bool isDisjoint() const;
 
    bool isIntersects() const;
 
    bool isTouches(int dimensionOfGeometryA, int dimensionOfGeometryB)
    const;
 
    bool isCrosses(int dimensionOfGeometryA, int dimensionOfGeometryB)
    const;
 
    bool isWithin() const;
 
    bool isContains() const;
 
    bool isEquals(int dimensionOfGeometryA, int dimensionOfGeometryB)
    const;
 
    bool isOverlaps(int dimensionOfGeometryA, int dimensionOfGeometryB)
    const;
 
    bool isCovers() const;
 
 
    bool isCoveredBy() const;
 
    IntersectionMatrix* transpose();
 
    std::string toString() const;
 
private:
 
    static const int firstDim; // = 3;
 
    static const int secondDim; // = 3;
 
    // Internal buffer for 3x3 matrix.
    std::array<std::array<int, 3>, 3> matrix;
 
}; // class IntersectionMatrix
 
GEOS_DLL std::ostream& operator<< (std::ostream& os, const IntersectionMatrix& im);
 
 
} // namespace geos::geom
} // namespace geos