geospatial.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#pragma once
 
 
#include <cstdint>
#include <optional>
#include <span>
#include <vector>
 
#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
 
namespace iceberg {
 
class ICEBERG_EXPORT GeospatialBound {
 public:
  static GeospatialBound XY(double x, double y);
  static GeospatialBound XYZ(double x, double y, double z);
  static GeospatialBound XYM(double x, double y, double m);
  static GeospatialBound XYZM(double x, double y, double z, double m);
 
  double x() const { return x_; }
  double y() const { return y_; }
  const std::optional<double>& z() const { return z_; }
  const std::optional<double>& m() const { return m_; }
 
  static Result<GeospatialBound> Deserialize(std::span<const uint8_t> bytes);
  std::vector<uint8_t> Serialize() const;
 
  friend bool operator==(const GeospatialBound&, const GeospatialBound&) = default;
 
 private:
  GeospatialBound(double x, double y, std::optional<double> z, std::optional<double> m);
 
  double x_;
  double y_;
  std::optional<double> z_;
  std::optional<double> m_;
};
 
class ICEBERG_EXPORT BoundingBox {
 public:
  BoundingBox(GeospatialBound lower, GeospatialBound upper);
 
  const GeospatialBound& lower() const { return lower_; }
  const GeospatialBound& upper() const { return upper_; }
 
  static Result<BoundingBox> Deserialize(std::span<const uint8_t> lower,
                                         std::span<const uint8_t> upper);
  static Result<BoundingBox> Deserialize(std::span<const uint8_t> bytes);
  std::vector<uint8_t> Serialize() const;
 
  friend bool operator==(const BoundingBox&, const BoundingBox&) = default;
 
 private:
  GeospatialBound lower_;
  GeospatialBound upper_;
};
 
ICEBERG_EXPORT Result<bool> GeospatialBoundsIntersect(const Type& type,
                                                      const BoundingBox& lhs,
                                                      const BoundingBox& rhs);
 
}  // namespace iceberg