jijmodeling 0.10.18__cp310-cp310-win_amd64.whl → 1.11.0__cp310-cp310-win_amd64.whl

jijmodeling/protobuf/to_protobuf/add_header_to_message.py

@@ -1,35 +0,0 @@
-from __future__ import annotations
-
-from typing import Union
-
-import jijmodeling_schema as pb
-
-from ulid import ULID
-
-
-def add_header_to_message(message: Union[pb.Expression, pb.Problem]) -> pb.Header:
-    """
-    Add header meta data to the `Expression` type message.
-
-    Args:
-        message (jijmodeling_schema.Expression): an `Expression` message
-
-    Returns:
-        jijmodeling_schema.Header: a `Header` message
-    """
-    # Create an empty `Header` message.
-    header = pb.Header()
-
-    # Make the id of the `Header` message.
-    header.id = str(ULID())
-
-    # Set the version of the JijModeling schema.
-    header.version = "0.10.0"
-
-    # Set the target message to the `header.value`.
-    if type(message) is pb.Problem:
-        header.value.problem = message
-    elif type(message) is pb.Expression:
-        header.value.expression = message
-
-    return header

jijmodeling/protobuf/to_protobuf/array_shape_to_message.py

@@ -1,43 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.placeholders import ArrayShape
-
-
-def array_shape_to_message(array_shape: ArrayShape) -> pb.Expression:
-    """
-    Convert an `ArrayShape` object to an `Expression` message.
-
-    Args:
-        array_shape (ArrayShape): an `ArrayShape` object
-
-    Returns:
-        pb.Expression: an `Expression` message
-    """
-    # Create an empty `ArrayShape` message.
-    array_shape_message = pb.ArrayShape()
-
-    # Set the number of axis
-    array_shape_message.axis = array_shape.dimension
-
-    # Create an empty `Expression` message.
-    message = pb.Expression()
-
-    # Set the id that the `ArrayShape` object has.
-    message.id = array_shape.uuid
-
-    # Set the kind of nodes to an `ArrayShape` message.
-    message.kind.array_shape = array_shape_message
-
-    # NOTE: Import a module within a local scope to fix a circular import.
-    # - https://stackoverflow.com/questions/59462679/design-of-python-conditional-imports
-    # - https://medium.com/@hamana.hadrien/so-you-got-a-circular-import-in-python-e9142fe10591
-    from jijmodeling.protobuf.to_protobuf.expression_to_message import (
-        expression_to_message,
-    )
-
-    # Set the array of the ArrayShape.
-    message.children.append(expression_to_message(array_shape.array))
-
-    return message

jijmodeling/protobuf/to_protobuf/binary_op_to_message.py

@@ -1,101 +0,0 @@
-from __future__ import annotations
-
-from typing import Union
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.condition import (
-    AndOperator,
-    Condition,
-    Equal,
-    LessThan,
-    LessThanEqual,
-    NotEqual,
-    OrOperator,
-    XorOperator,
-)
-from jijmodeling.expression.expression import Add, BinaryOperator, Div, Mod, Mul, Power
-from jijmodeling.expression.variables.variable import Range
-
-
-def binary_op_to_message(
-    binary_op: Union[BinaryOperator, Range, Condition]
-) -> pb.Expression:
-    """
-    Convert a `BinaryOperator | Range | Condition` object to an `Expression`.
-
-    message.
-
-    Args:
-        unary_op (BinaryOperator): an expression node that has two children
-
-    Returns:
-        pb.Expression: an `Expression` message
-    """
-    # Create an empty `BinaryOp` message.
-    binary_op_message = pb.BinaryOp()
-
-    # Set the kind of the binary operator node.
-    # BinaryOp
-    if type(binary_op) is Add:
-        binary_op_message.kind = pb.BinaryOpKind.ADD
-    elif type(binary_op) is Mul:
-        binary_op_message.kind = pb.BinaryOpKind.MUL
-    elif type(binary_op) is Div:
-        binary_op_message.kind = pb.BinaryOpKind.DIV
-    elif type(binary_op) is Power:
-        binary_op_message.kind = pb.BinaryOpKind.POW
-    elif type(binary_op) is Mod:
-        binary_op_message.kind = pb.BinaryOpKind.MOD
-    # Range
-    elif type(binary_op) is Range:
-        binary_op_message.kind = pb.BinaryOpKind.RANGE
-    # ComparisonOp
-    elif type(binary_op) is Equal:
-        binary_op_message.kind = pb.BinaryOpKind.EQ
-    elif type(binary_op) is NotEqual:
-        binary_op_message.kind = pb.BinaryOpKind.NOT_EQ
-    elif type(binary_op) is LessThan:
-        binary_op_message.kind = pb.BinaryOpKind.LESS_THAN
-    elif type(binary_op) is LessThanEqual:
-        binary_op_message.kind = pb.BinaryOpKind.LESS_THAN_EQ
-    # LogicalOp
-    elif type(binary_op) is AndOperator:
-        binary_op_message.kind = pb.BinaryOpKind.AND
-    elif type(binary_op) is OrOperator:
-        binary_op_message.kind = pb.BinaryOpKind.OR
-    elif type(binary_op) is XorOperator:
-        binary_op_message.kind = pb.BinaryOpKind.XOR
-    # Otherwise
-    else:
-        raise TypeError(f"{binary_op.__class__.__name__} is not supported")
-
-    # Create an empty `Expression` message.
-    message = pb.Expression()
-
-    # Set the id that the `Expression` object has.
-    message.id = binary_op.uuid
-
-    # Set the kind of nodes to the `BinaryOp` message.
-    message.kind.binary_op = binary_op_message
-
-    # NOTE: Import a module within a local scope to fix a circular import.
-    # - https://stackoverflow.com/questions/59462679/design-of-python-conditional-imports
-    # - https://medium.com/@hamana.hadrien/so-you-got-a-circular-import-in-python-e9142fe10591
-    from jijmodeling.protobuf.to_protobuf.expression_to_message import (
-        expression_to_message,
-    )
-
-    if type(binary_op) is Range:
-        # Set the range of the `Range` object.
-        message.children.append(expression_to_message(binary_op.start))
-        message.children.append(expression_to_message(binary_op.last))
-    elif isinstance(binary_op, (BinaryOperator, Condition)):
-        # Set the children of the `BinaryOperator` object.
-        message.children.append(expression_to_message(binary_op.left))
-        message.children.append(expression_to_message(binary_op.right))
-    # Otherwise
-    else:
-        raise TypeError(f"{binary_op.__class__.__name__} is not supported")
-
-    return message

jijmodeling/protobuf/to_protobuf/binary_var_to_message.py

@@ -1,49 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.deci_vars import Binary
-
-
-def binary_var_to_message(binary_var: Binary) -> pb.Expression:
-    """
-    Convert a `Binary` object to an `BinaryVar` message.
-
-    Args:
-        binary_var (Binary): a `Binary` object.
-
-    Returns:
-        pb.Expression: an `Expression` message.
-    """
-    # Create an empty `BinaryVar` message.
-    binary_var_message = pb.BinaryVar()
-
-    # Set the symbol.
-    binary_var_message.symbol = binary_var.label
-
-    # Set length of the shape.
-    binary_var_message.dim = binary_var.dim
-
-    # Create an empty `Expression` message.
-    message = pb.Expression()
-
-    # Set the id that the `Binary` object has.
-    message.id = binary_var.uuid
-
-    # Set the kind of nodes to a `BinaryVar` message.
-    message.kind.binary_var = binary_var_message
-
-    # NOTE: Import a module within a local scope to fix a circular import.
-    # - https://stackoverflow.com/questions/59462679/design-of-python-conditional-imports
-    # - https://medium.com/@hamana.hadrien/so-you-got-a-circular-import-in-python-e9142fe10591
-    from jijmodeling.protobuf.to_protobuf.expression_to_message import (
-        expression_to_message,
-    )
-
-    # Set the shape.
-    message.children = [
-        expression_to_message(shape_element) for shape_element in binary_var.shape
-    ]
-
-    # Serialize the `Expression` object into a bytes object.
-    return message

jijmodeling/protobuf/to_protobuf/constraint_to_message.py

@@ -1,52 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from ulid import ULID
-
-from jijmodeling.expression.constraint import Constraint
-from jijmodeling.protobuf.to_protobuf.expression_to_message import expression_to_message
-from jijmodeling.protobuf.to_protobuf.forall_to_message import forall_to_message
-
-
-def constraint_to_message(constraint: Constraint) -> pb.Constraint:
-    """
-    Convert a `Constraint` object into a `Constraint` message.
-
-    Args:
-        constraint (Constraint): a `Constraint` object
-
-    Returns:
-        pb.Constraint: a `Constraint` message
-    """
-    # Create an empty `Constraint` message.
-    message = pb.Constraint()
-
-    # Set the id of the constraint.
-    message.id = str(ULID())
-
-    # Set the name of the constraint.
-    message.name = constraint.label
-
-    # Set the expression of the constraint.
-    message.expression = expression_to_message(constraint.condition)
-
-    # Set the list of forall.
-    message.forall.extend(
-        [
-            forall_to_message(element, condition)
-            for element, condition in constraint.forall
-        ]
-    )
-
-    # Set the left_lower.
-    if constraint.left_lower is not None:
-        message.left_lower = expression_to_message(constraint.left_lower)
-
-    message.is_penalty = constraint.with_penalty
-
-    message.needs_multiplier = constraint.with_multiplier
-
-    message.needs_square = constraint.auto_qubo
-
-    return message

jijmodeling/protobuf/to_protobuf/element_to_message.py

@@ -1,43 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.variable import Element
-
-
-def element_to_message(element: Element) -> pb.Expression:
-    """
-    Convert an `Element` object to an `Element` message.
-
-    Args:
-        element (Element): an `Element` object
-
-    Returns:
-        pb.Expression: an `Element` message
-    """
-    # Create an empty `ArrayShape` message.
-    element_message = pb.Element()
-
-    # Set the symbol
-    element_message.symbol = element.label
-
-    # Create an empty `Expression` message.
-    message = pb.Expression()
-
-    # Set the id that the `Element` object has.
-    message.id = element.uuid
-
-    # Set the kind of nodes to an `ArrayShape` message.
-    message.kind.element = element_message
-
-    # NOTE: Import a module within a local scope to fix a circular import.
-    # - https://stackoverflow.com/questions/59462679/design-of-python-conditional-imports
-    # - https://medium.com/@hamana.hadrien/so-you-got-a-circular-import-in-python-e9142fe10591
-    from jijmodeling.protobuf.to_protobuf.expression_to_message import (
-        expression_to_message,
-    )
-
-    # Set the parent of the `Element` object.
-    message.children.append(expression_to_message(element.parent))
-
-    return message

jijmodeling/protobuf/to_protobuf/expression_to_message.py

@@ -1,89 +0,0 @@
-from __future__ import annotations
-
-from typing import Union
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.condition import Condition
-from jijmodeling.expression.expression import BinaryOperator, Expression, Number
-from jijmodeling.expression.mathfunc import UnaryOperator
-from jijmodeling.expression.sum import ReductionOperator
-from jijmodeling.expression.variables.deci_vars import Binary, Integer
-from jijmodeling.expression.variables.jagged_array import JaggedArray
-from jijmodeling.expression.variables.placeholders import ArrayShape, Placeholder
-from jijmodeling.expression.variables.variable import Element, Range, Subscripts
-from jijmodeling.protobuf.to_protobuf.array_shape_to_message import (
-    array_shape_to_message,
-)
-from jijmodeling.protobuf.to_protobuf.binary_op_to_message import binary_op_to_message
-from jijmodeling.protobuf.to_protobuf.binary_var_to_message import binary_var_to_message
-from jijmodeling.protobuf.to_protobuf.element_to_message import element_to_message
-from jijmodeling.protobuf.to_protobuf.integer_var_to_message import (
-    integer_var_to_message,
-)
-from jijmodeling.protobuf.to_protobuf.jagged_array_to_message import (
-    jagged_array_to_message,
-)
-from jijmodeling.protobuf.to_protobuf.number_lit_to_message import number_lit_to_message
-from jijmodeling.protobuf.to_protobuf.placeholder_to_message import (
-    placeholder_to_message,
-)
-from jijmodeling.protobuf.to_protobuf.reduction_op_to_message import (
-    reduction_op_to_message,
-)
-from jijmodeling.protobuf.to_protobuf.subscript_op_to_message import (
-    subscript_op_to_message,
-)
-from jijmodeling.protobuf.to_protobuf.unary_op_to_message import unary_op_to_message
-
-
-def expression_to_message(expr: Union[Expression, Range, Condition]) -> pb.Expression:
-    """
-    Convert a `Expression` instance object to an `Expression` message.
-
-    Args:
-        expr (Expression): an `Expression` instance object
-
-    Raises:
-        TypeError: the error occurs if the instance ofject cannot be converted to a protobuf object
-
-    Returns:
-        pb.Expression: a `Expression` message
-    """
-    if type(expr) is Number:
-        message = number_lit_to_message(expr)
-        return message
-    elif type(expr) is Placeholder:
-        message = placeholder_to_message(expr)
-        return message
-    elif type(expr) is ArrayShape:
-        message = array_shape_to_message(expr)
-        return message
-    elif type(expr) is Element:
-        message = element_to_message(expr)
-        return message
-    elif type(expr) is JaggedArray:
-        message = jagged_array_to_message(expr)
-        return message
-    elif type(expr) is Binary:
-        message = binary_var_to_message(expr)
-        return message
-    elif type(expr) is Integer:
-        message = integer_var_to_message(expr)
-        return message
-    elif isinstance(expr, UnaryOperator):
-        message = unary_op_to_message(expr)
-        return message
-    elif isinstance(expr, (BinaryOperator, Range, Condition)):
-        message = binary_op_to_message(expr)
-        return message
-    elif type(expr) is Subscripts:
-        message = subscript_op_to_message(expr)
-        return message
-    elif isinstance(expr, ReductionOperator):
-        message = reduction_op_to_message(expr)
-        return message
-    else:
-        raise TypeError(
-            f"{expr.__class__.__name__} is not supported for converting it into a protobuf message."
-        )

jijmodeling/protobuf/to_protobuf/forall_to_message.py

@@ -1,32 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.condition import Condition, NoneCondition
-from jijmodeling.expression.variables.variable import Element
-from jijmodeling.protobuf.to_protobuf.element_to_message import element_to_message
-from jijmodeling.protobuf.to_protobuf.expression_to_message import expression_to_message
-
-
-def forall_to_message(element: Element, condition: Condition) -> pb.Forall:
-    """
-    Convert a `forall` object into a `Forall` message.
-
-    Args:
-        element (Element): an `Element` object
-        condition (Condition): a `Condition` object
-
-    Returns:
-        pb.Forall: a `Forall` message
-    """
-    # Create an empty `Forall` message.
-    message = pb.Forall()
-
-    # Set the element.
-    message.element = element_to_message(element)
-
-    # Set the condition expression for the element.
-    if type(condition) is not NoneCondition:
-        message.condition = expression_to_message(condition)
-
-    return message

jijmodeling/protobuf/to_protobuf/integer_var_to_message.py

@@ -1,54 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.deci_vars import Integer
-
-
-def integer_var_to_message(integer_var: Integer) -> pb.Expression:
-    """
-    Convert an `Integer` object to an `IntegerVar` message.
-
-    Args:
-        integer_var (Integer): an `Integer` object.
-
-    Returns:
-        pb.Expression: an `Expression` message.
-    """
-    # Create an empty `IntegerVar` message.
-    integer_var_message = pb.IntegerVar()
-
-    # Set the symbol
-    integer_var_message.symbol = integer_var.label
-    # Set length of the shape
-    integer_var_message.dim = integer_var.dim
-
-    # Create an empty `Expression` message.
-    message = pb.Expression()
-
-    # Set the id that the `Integer` object has.
-    message.id = integer_var.uuid
-
-    # Set the kind of nodes to a `IntegerVar` message.
-    message.kind.integer_var = integer_var_message
-
-    # NOTE: Import a module within a local scope to fix a circular import.
-    # - https://stackoverflow.com/questions/59462679/design-of-python-conditional-imports
-    # - https://medium.com/@hamana.hadrien/so-you-got-a-circular-import-in-python-e9142fe10591
-    from jijmodeling.protobuf.to_protobuf.expression_to_message import (
-        expression_to_message,
-    )
-
-    # Set the bound of the `Integer` object.
-    # lower bound
-    message.children.append(expression_to_message(integer_var.lower))
-    # upper bound
-    message.children.append(expression_to_message(integer_var.upper))
-
-    # Set the shape.
-    message.children.extend(
-        [expression_to_message(shape_element) for shape_element in integer_var.shape]
-    )
-
-    # Serialize the `Expression` object into a bytes object.
-    return message

jijmodeling/protobuf/to_protobuf/jagged_array_to_message.py

@@ -1,37 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.jagged_array import JaggedArray
-
-
-def jagged_array_to_message(jagged_array: JaggedArray) -> pb.Expression:
-    """
-    Convert a `JaggedArray` object to a `JaggedArray` message.
-
-    Args:
-        jagged_array (JaggedArray): a `JaggedArray` object
-
-    Returns:
-        pb.Expression: a `JaggedArray` object
-    """
-    # Create an empty `JaggedArray` message.
-    jagged_array_message = pb.JaggedArray()
-
-    # Set the symbol.
-    jagged_array_message.symbol = jagged_array.label
-
-    # Set the number of dimensions.
-    jagged_array_message.dim = jagged_array.dim
-
-    # Create an empty `Expression` message.
-    message = pb.Expression()
-
-    # Set the id that the `JaggedArray` object has.
-    message.id = jagged_array.uuid
-
-    # Set the kind of nodes to a `JaggedArray` message.
-    message.kind.jagged_array = jagged_array_message
-
-    # Serialize the `Expression` object into a bytes object.
-    return message

jijmodeling/protobuf/to_protobuf/number_lit_to_message.py

@@ -1,52 +0,0 @@
-from __future__ import annotations
-
-import struct
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.expression import DataType, Number
-
-
-def number_lit_to_message(lit: Number) -> pb.Expression:
-    """
-    Convert a `Number` object to an `Expression` message.
-
-    Args:
-        lit (Number): a `Number` object
-
-    Returns:
-        jijmodeling_schema.Expression: an `Expression` message
-    """
-    # Create an empty `NumberLit` message.
-    number_lit = pb.NumberLit()
-
-    # Set the type of the value that the `Number` object has.
-    # Case: int
-    if lit.dtype == DataType.INT:
-        number_lit.type = pb.NumberLitType.INTEGER
-
-        # Set the value that the `Number` object has.
-        # Convert the value to the bytes object.
-        number_lit.value = int.from_bytes(struct.pack(">q", lit.value), "big")
-    # Case: float
-    elif lit.dtype == DataType.FLOAT:
-        number_lit.type = pb.NumberLitType.FLOAT
-
-        # Set the value that the `Number` object has.
-        # Convert the value to the bytes object.
-        number_lit.value = int.from_bytes(struct.pack(">d", lit.value), "big")
-    # Otherwise
-    else:
-        number_lit.type = pb.NumberLitType.UNKNOWN
-
-    # Create an empty `Expression` message.
-    message = pb.Expression()
-
-    # Set the id that the `Number` object has.
-    message.id = lit.uuid
-
-    # Set the kind of nodes to `NumberLit`.
-    message.kind.number_lit = number_lit
-
-    # Serialize the `Expression` object into a bytes object.
-    return message

jijmodeling/protobuf/to_protobuf/penalty_to_message.py

@@ -1,42 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from ulid import ULID
-
-from jijmodeling.expression.constraint import Penalty
-from jijmodeling.protobuf.to_protobuf.expression_to_message import expression_to_message
-from jijmodeling.protobuf.to_protobuf.forall_to_message import forall_to_message
-
-
-def penalty_to_message(penalty: Penalty) -> pb.Penalty:
-    """
-    Convert a `Penalty` object into a `Penalty` message.
-
-    Args:
-        penalty (Penalty): a `Penalty` object
-
-    Returns:
-        pb.Penalty: a `Penalty` message
-    """
-    # Create an empty `Penalty` message
-    message = pb.Penalty()
-
-    # Set the id of the penalty.
-    message.id = str(ULID())
-
-    # Set the name of the penalty.
-    message.name = penalty.label
-
-    # Set the penalty term.
-    message.expression = expression_to_message(penalty.penalty_term)
-
-    # Set the list of forall.
-    message.forall.extend(
-        [forall_to_message(element, condition) for element, condition in penalty.forall]
-    )
-
-    # Set the needs_multiplier
-    message.needs_multiplier = penalty.with_multiplier
-
-    return message