vrp-model 0.1.1__py3-none-any.whl

vrp_model/__init__.py

@@ -0,0 +1,65 @@
+"""vrp_model: canonical VRP modeling API (solver-agnostic core)."""
+
+from vrp_model.core.errors import (
+    MappingError,
+    SolutionUnavailableError,
+    SolverCapabilityError,
+    SolverNotInstalledError,
+    ValidationError,
+    VRPModelError,
+)
+from vrp_model.core.kinds import NodeKind
+from vrp_model.core.model import Feature, Model, SolveStatus
+from vrp_model.core.solution import Route, Solution
+from vrp_model.core.time_window_flex import TimeWindowFlex
+from vrp_model.core.travel_edges import TRAVEL_COST_INF, TravelEdgeAttrs, TravelEdgesMap
+from vrp_model.core.views import Depot, Job, Vehicle
+from vrp_model.solvers.base import Solver
+from vrp_model.solvers.options import (
+    GAP_ABS,
+    GAP_REL,
+    LOG_PATH,
+    MAX_ITERATIONS,
+    MSG,
+    SEED,
+    TIME_LIMIT,
+    SolverOptions,
+    default_solver_options,
+    merge_solver_options,
+)
+from vrp_model.solvers.status import SolutionStatus, SolverStopReason
+
+__all__ = [
+    "Depot",
+    "Feature",
+    "GAP_ABS",
+    "GAP_REL",
+    "Job",
+    "LOG_PATH",
+    "MappingError",
+    "MSG",
+    "Model",
+    "NodeKind",
+    "Route",
+    "Solution",
+    "SolveStatus",
+    "TIME_LIMIT",
+    "TimeWindowFlex",
+    "TRAVEL_COST_INF",
+    "TravelEdgeAttrs",
+    "TravelEdgesMap",
+    "MAX_ITERATIONS",
+    "SEED",
+    "Solver",
+    "SolverOptions",
+    "SolverCapabilityError",
+    "SolutionStatus",
+    "SolutionUnavailableError",
+    "SolverNotInstalledError",
+    "SolverStopReason",
+    "ValidationError",
+    "VRPModelError",
+    "Vehicle",
+    "default_solver_options",
+    "merge_solver_options",
+]

vrp_model/core/__init__.py

@@ -0,0 +1,38 @@
+"""Core model, solution, and feature types."""
+
+from vrp_model.core.errors import (
+    MappingError,
+    SolutionUnavailableError,
+    SolverCapabilityError,
+    SolverNotInstalledError,
+    ValidationError,
+    VRPModelError,
+)
+from vrp_model.core.kinds import NodeKind
+from vrp_model.core.model import Feature, Model, SolveStatus
+from vrp_model.core.solution import Route, Solution
+from vrp_model.core.time_window_flex import TimeWindowFlex
+from vrp_model.core.travel_edges import TRAVEL_COST_INF, TravelEdgeAttrs, TravelEdgesMap
+from vrp_model.core.views import Depot, Job, Vehicle
+
+__all__ = [
+    "Depot",
+    "Feature",
+    "Job",
+    "MappingError",
+    "Model",
+    "NodeKind",
+    "Route",
+    "Solution",
+    "SolveStatus",
+    "TRAVEL_COST_INF",
+    "TravelEdgeAttrs",
+    "TravelEdgesMap",
+    "TimeWindowFlex",
+    "SolverCapabilityError",
+    "SolverNotInstalledError",
+    "SolutionUnavailableError",
+    "ValidationError",
+    "VRPModelError",
+    "Vehicle",
+]

vrp_model/core/errors.py

@@ -0,0 +1,25 @@
+"""Domain-specific exceptions."""
+
+
+class VRPModelError(Exception):
+    """Base error for vrp_model."""
+
+
+class ValidationError(VRPModelError):
+    """Model failed structure, consistency, or feasibility validation."""
+
+
+class SolverCapabilityError(VRPModelError):
+    """Solver does not support one or more features present on the model."""
+
+
+class SolverNotInstalledError(VRPModelError):
+    """Optional solver dependency is not installed."""
+
+
+class MappingError(VRPModelError):
+    """Canonical model ↔ solver-native conversion failed."""
+
+
+class SolutionUnavailableError(VRPModelError):
+    """Raised when a method requires an attached solution but ``model.solution`` is ``None``."""

vrp_model/core/kinds.py

@@ -0,0 +1,12 @@
+"""Node classification for unified ``Model._nodes`` storage."""
+
+from __future__ import annotations
+
+from enum import Enum, auto
+
+
+class NodeKind(Enum):
+    """Discriminator for rows in :attr:`~vrp_model.core.model.Model._nodes`."""
+
+    DEPOT = auto()
+    JOB = auto()