pycsp3-scheduling 0.2.1__py3-none-any.whl

pycsp3_scheduling/__init__.py

@@ -0,0 +1,220 @@
+"""
+pycsp3-scheduling: Scheduling extension for pycsp3.
+
+This package extends pycsp3 with comprehensive scheduling support including:
+- Interval variables (IntervalVar)
+- Sequence variables (SequenceVar)
+- Precedence constraints (end_before_start, start_at_start, etc.)
+- Grouping constraints (span, alternative, synchronize)
+- Sequence constraints (SeqNoOverlap, first, last, before, previous)
+- Sequence consistency constraints (same_sequence, same_common_subsequence)
+- Sequence accessor expressions (start_of_next, start_of_prev, etc.)
+- Cumulative functions (pulse, step_at_start, step_at_end, Cumulative)
+- State functions (StateFunction, TransitionMatrix, always_equal, etc.)
+- XCSP3 scheduling extension output [future]
+
+"""
+
+from __future__ import annotations
+
+__version__ = "0.2.0"
+__author__ = "Sohaib AFIFI"
+
+# Variables
+from pycsp3_scheduling.variables import (
+    INTERVAL_MAX,
+    INTERVAL_MIN,
+    IntervalVar,
+    IntervalVarArray,
+    IntervalVarDict,
+    SequenceVar,
+    SequenceVarArray,
+)
+
+# Expressions
+from pycsp3_scheduling.expressions import (
+    ElementMatrix,
+    IntervalExpr,
+    clear_sequence_expr_cache,
+    element,
+    element2d,
+    end_of,
+    end_of_next,
+    end_of_prev,
+    expr_max,
+    expr_min,
+    length_of,
+    length_of_next,
+    length_of_prev,
+    overlap_length,
+    presence_of,
+    size_of,
+    size_of_next,
+    size_of_prev,
+    start_of,
+    start_of_next,
+    start_of_prev,
+    type_of_next,
+    type_of_prev,
+)
+
+# Interop
+from pycsp3_scheduling.interop import (
+    IntervalValue,
+    ModelStatistics,
+    SolutionStatistics,
+    end_time,
+    interval_value,
+    model_statistics,
+    presence_time,
+    solution_statistics,
+    start_time,
+)
+
+# Constraints
+from pycsp3_scheduling.constraints import (
+    SeqCumulative,
+    SeqNoOverlap,
+    alternative,
+    before,
+    end_at_end,
+    end_at_start,
+    end_before_end,
+    end_before_start,
+    first,
+    last,
+    previous,
+    same_common_subsequence,
+    same_sequence,
+    span,
+    start_at_end,
+    start_at_start,
+    start_before_end,
+    start_before_start,
+    synchronize,
+)
+
+# Cumulative Functions
+from pycsp3_scheduling.functions import (
+    CumulExpr,
+    CumulFunction,
+    CumulConstraint,
+    CumulHeightExpr,
+    always_in,
+    cumul_range,
+    height_at_end,
+    height_at_start,
+    pulse,
+    step_at,
+    step_at_end,
+    step_at_start,
+)
+
+# State Functions
+from pycsp3_scheduling.functions import (
+    StateFunction,
+    StateConstraint,
+    TransitionMatrix,
+    always_constant,
+    always_equal,
+    always_no_state,
+)
+
+# Visualization (imported as submodule)
+from pycsp3_scheduling import visu
+
+__all__ = [
+    "__version__",
+    # Variables
+    "IntervalVar",
+    "IntervalVarArray",
+    "IntervalVarDict",
+    "SequenceVar",
+    "SequenceVarArray",
+    "INTERVAL_MIN",
+    "INTERVAL_MAX",
+    # Expressions - Basic
+    "IntervalExpr",
+    "start_of",
+    "end_of",
+    "size_of",
+    "length_of",
+    "presence_of",
+    "overlap_length",
+    "expr_min",
+    "expr_max",
+    # Expressions - Sequence Next
+    "start_of_next",
+    "end_of_next",
+    "size_of_next",
+    "length_of_next",
+    "type_of_next",
+    # Expressions - Sequence Prev
+    "start_of_prev",
+    "end_of_prev",
+    "size_of_prev",
+    "length_of_prev",
+    "type_of_prev",
+    # Expressions - Element (array indexing)
+    "ElementMatrix",
+    "element",
+    "element2d",
+    "clear_sequence_expr_cache",
+    # Interop
+    "start_time",
+    "end_time",
+    "presence_time",
+    "interval_value",
+    "IntervalValue",
+    "model_statistics",
+    "solution_statistics",
+    "ModelStatistics",
+    "SolutionStatistics",
+    # Constraints - Exact timing
+    "start_at_start",
+    "start_at_end",
+    "end_at_start",
+    "end_at_end",
+    # Constraints - Before
+    "start_before_start",
+    "start_before_end",
+    "end_before_start",
+    "end_before_end",
+    # Constraints - Grouping
+    "span",
+    "alternative",
+    "synchronize",
+    # Constraints - Sequence
+    "SeqNoOverlap",
+    "first",
+    "last",
+    "before",
+    "previous",
+    # Constraints - Sequence Consistency
+    "same_sequence",
+    "same_common_subsequence",
+    # Constraints - Cumulative
+    "SeqCumulative",
+    # Cumulative Functions
+    "CumulExpr",
+    "CumulFunction",
+    "CumulConstraint",
+    "CumulHeightExpr",
+    "pulse",
+    "step_at",
+    "step_at_start",
+    "step_at_end",
+    "cumul_range",
+    "always_in",
+    "height_at_start",
+    "height_at_end",
+    # State Functions
+    "StateFunction",
+    "StateConstraint",
+    "TransitionMatrix",
+    "always_equal",
+    "always_constant",
+    "always_no_state",
+    # Visualization
+    "visu",
+]

pycsp3_scheduling/constraints/__init__.py

@@ -0,0 +1,87 @@
+"""
+Scheduling constraints.
+
+This module provides:
+- Precedence constraints: end_before_start, start_at_start, etc.
+- Grouping constraints: span, alternative, synchronize
+- Sequence constraints: SeqNoOverlap, first, last, before, previous
+- Sequence consistency: same_sequence, same_common_subsequence
+- Cumulative constraints: Cumulative (capacity constraint)
+- State constraints: always_equal, always_constant, always_no_state (future)
+- Forbidden region constraints: forbid_start, forbid_end, forbid_extent (future)
+"""
+
+from __future__ import annotations
+
+# Precedence constraints (exact timing + before)
+from pycsp3_scheduling.constraints.precedence import (
+    end_at_end,
+    end_at_start,
+    end_before_end,
+    end_before_start,
+    start_at_end,
+    start_at_start,
+    start_before_end,
+    start_before_start,
+)
+
+# Grouping constraints
+from pycsp3_scheduling.constraints.grouping import (
+    alternative,
+    span,
+    synchronize,
+)
+
+# Sequence constraints
+from pycsp3_scheduling.constraints.sequence import (
+    SeqNoOverlap,
+    before,
+    first,
+    last,
+    previous,
+    same_common_subsequence,
+    same_sequence,
+)
+
+# Cumulative constraints
+from pycsp3_scheduling.constraints.cumulative import (
+    SeqCumulative,
+    build_cumul_constraint,
+)
+
+# To be implemented:
+# from pycsp3_scheduling.constraints.state import (
+#     always_in, always_equal, always_constant, always_no_state,
+# )
+# from pycsp3_scheduling.constraints.forbidden import (
+#     forbid_start, forbid_end, forbid_extent,
+# )
+
+__all__ = [
+    # Exact timing constraints
+    "start_at_start",
+    "start_at_end",
+    "end_at_start",
+    "end_at_end",
+    # Before constraints
+    "start_before_start",
+    "start_before_end",
+    "end_before_start",
+    "end_before_end",
+    # Grouping constraints
+    "span",
+    "alternative",
+    "synchronize",
+    # Sequence constraints
+    "SeqNoOverlap",
+    "first",
+    "last",
+    "before",
+    "previous",
+    # Sequence consistency
+    "same_sequence",
+    "same_common_subsequence",
+    # Cumulative constraints
+    "SeqCumulative",
+    "build_cumul_constraint",
+]