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

jijmodeling/protobuf/from_protobuf/extract_attribute_value_from_header.py

@@ -1,26 +0,0 @@
-from __future__ import annotations
-
-from typing import Union
-
-import jijmodeling_schema as pb
-
-
-def extract_attribute_value_from_header(
-    bytes: bytes,
-) -> Union[pb.Problem, pb.Expression]:
-    """
-    Extract the attribute value from a header messsage.
-
-    Args:
-        bytes (bytes): a bytes object that can be decoded in the `Header` message
-
-    Returns:
-        Union[pb.Problem, pb.Expression]: an instance object of either `Problem` message class or `Expression` message class
-    """
-    # Convert the bytes object into the `Header` message object.
-    header = pb.Header.FromString(bytes)
-
-    # Extract the attribute value from the header message.
-    attribute_value = pb.betterproto.which_one_of(header.value, "value")[1]
-
-    return attribute_value

jijmodeling/protobuf/from_protobuf/from_protobuf.py

@@ -1,38 +0,0 @@
-from __future__ import annotations
-
-from typing import Union
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.expression import Expression
-from jijmodeling.problem.problem import Problem
-from jijmodeling.protobuf.from_protobuf.extract_attribute_value_from_header import (
-    extract_attribute_value_from_header,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_expression import (
-    message_to_expression,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_problem import message_to_problem
-
-
-def from_protobuf(bytes: bytes) -> Union[Problem, Expression]:
-    """
-    Convert a bytes object in protobuf to a JijModeling's object.
-
-    Args:
-        bytes (bytes): a bytes object in protobuf
-
-    Returns:
-        Expression: an expression
-    """
-    # Convert the bytes object into the message object.
-    attribute_value = extract_attribute_value_from_header(bytes)
-
-    if type(attribute_value) is pb.Problem:
-        return message_to_problem(attribute_value)
-    elif isinstance(attribute_value, pb.Expression):
-        return message_to_expression(attribute_value)
-    else:
-        raise RuntimeError(
-            f"cannot convert the bytes object into the instance object according to the class in JijModeling (bytes = {str(bytes)})"
-        )

jijmodeling/protobuf/from_protobuf/message_to_array_shape.py

@@ -1,35 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.placeholders import ArrayShape
-
-
-def message_to_array_shape(
-    id: str, message: pb.ArrayShape, array: pb.Expression
-) -> ArrayShape:
-    """
-    Convert a message to a `ArrayShape` object.
-
-    Args:
-        id (str): the id of the `ArrayShape` object
-        message (pb.ArrayShape): the `ArrayShape` message
-        array (pb.Expression): the target array of the array shape
-
-    Returns:
-        ArrayShape: an `ArrayShape` object
-    """
-    # Set the number of axis.
-    axis = message.axis
-
-    # 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.from_protobuf.message_to_expression import (
-        message_to_expression,
-    )
-
-    # Set the target array of this array shape.
-    array = message_to_expression(array)
-
-    return ArrayShape(uuid=id, array=array, dimension=axis)

jijmodeling/protobuf/from_protobuf/message_to_binary_op.py

@@ -1,83 +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 message_to_binary_op(
-    id: str, message: pb.BinaryOp, left: pb.Expression, right: pb.Expression
-) -> Union[BinaryOperator, Range, Condition]:
-    """
-    Convert a message to a `BinaryOperator` object.
-
-    Args:
-        id (str): the id of the `BinaryOperator` object
-        message (pb.BinaryOp): the `BinaryOp` message
-        operand (pb.Expression): the operand node that the `BinaryOp` message has
-
-    Raises:
-        TypeError: the error happens if the message cannot be converted to a `BinaryOperator` object
-
-    Returns:
-        BinaryOperator: a `BinaryOperator` object
-    """
-    # 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.from_protobuf.message_to_expression import (
-        message_to_expression,
-    )
-
-    # Convert the children to the `Expression` objects.
-    lhs = message_to_expression(left)
-    rhs = message_to_expression(right)
-
-    # BinaryOp
-    if message.kind == pb.BinaryOpKind.ADD:
-        return Add(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.MUL:
-        return Mul(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.DIV:
-        return Div(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.POW:
-        return Power(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.MOD:
-        return Mod(uuid=id, left=lhs, right=rhs)
-    # Range
-    elif message.kind == pb.BinaryOpKind.RANGE:
-        return Range(start=lhs, last=rhs, uuid=id)
-    # ComparisonOp
-    elif message.kind == pb.BinaryOpKind.EQ:
-        return Equal(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.NOT_EQ:
-        return NotEqual(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.LESS_THAN:
-        return LessThan(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.LESS_THAN_EQ:
-        return LessThanEqual(uuid=id, left=lhs, right=rhs)
-    # Logicalop
-    elif message.kind == pb.BinaryOpKind.AND:
-        return AndOperator(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.OR:
-        return OrOperator(uuid=id, left=lhs, right=rhs)
-    elif message.kind == pb.BinaryOpKind.XOR:
-        return XorOperator(uuid=id, left=lhs, right=rhs)
-    # Otherwise
-    else:
-        raise TypeError(
-            f"cannot convert the binary operator (actual = {message}) to an expression."
-        )

jijmodeling/protobuf/from_protobuf/message_to_binary_var.py

@@ -1,46 +0,0 @@
-from __future__ import annotations
-
-from typing import List
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.deci_vars import Binary
-
-
-def message_to_binary_var(
-    id: str, message: pb.BinaryVar, shape: List[pb.Expression]
-) -> Binary:
-    """
-    Convert a message to a `Binary` object.
-
-    Args:
-        id (str): the id of the `Binary` object
-        message (pb.BinaryVar): the `BinaryVar` message
-        shape (List[pb.Expression]): the shape of the `Binary` object
-
-    Raises:
-        ValueError: the error occurs if `dim` is not equal to length of the shape
-
-    Returns:
-        Binary: a `Binary` object
-    """
-    # Validate length of the shape.
-    if message.dim != len(shape):
-        raise ValueError("invalid length of the shape")
-
-    # Set the symbol.
-    symbol = message.symbol
-
-    # 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.from_protobuf.message_to_expression import (
-        message_to_expression,
-    )
-
-    # Set the shape.
-    shape_element_list = [
-        message_to_expression(shape_element) for shape_element in shape
-    ]
-
-    return Binary(label=symbol, shape=shape_element_list, uuid=id)

jijmodeling/protobuf/from_protobuf/message_to_constraint.py

@@ -1,48 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.constraint import Constraint
-from jijmodeling.protobuf.from_protobuf.message_to_expression import (
-    message_to_expression,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_forall import message_to_forall
-
-
-def message_to_constraint(constraint: pb.Constraint) -> Constraint:
-    """
-    Convert a `Constraint` message into a `Constraint` object.
-
-    Args:
-        constraint (pb.Constraint): a `Constraint` message
-
-    Returns:
-        Constraint: a `Constraint` object
-    """
-    # Set the name of the constraint.
-    name = constraint.name
-
-    # Set the condition expression.
-    condition = message_to_expression(constraint.expression)
-
-    # Set the list of forall.
-    forall = [message_to_forall(forall) for forall in constraint.forall]
-
-    # Set the left_lower.
-    has_left_lower = (
-        pb.betterproto.which_one_of(constraint.left_lower.kind, "kind")[1] is not None
-    )
-    if has_left_lower:
-        left_lower = message_to_expression(constraint.left_lower)
-    else:
-        left_lower = None
-
-    return Constraint(
-        label=name,
-        condition=condition,
-        forall=forall,
-        left_lower=left_lower,
-        with_penalty=constraint.is_penalty,
-        with_multiplier=constraint.needs_multiplier,
-        auto_qubo=constraint.needs_square,
-    )

jijmodeling/protobuf/from_protobuf/message_to_element.py

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.variable import Element
-
-
-def message_to_element(id: str, message: pb.Element, parent: pb.Expression) -> Element:
-    """
-    Convert a message to a `Element` object.
-
-    Args:
-        id (str): the id of the `Element` object
-        message (pb.Element): the `Element` message
-        parent (pb.Expression): the parent node that the `Element` message has
-
-    Returns:
-        Element: an `Element` object
-    """
-    # Set the symbol
-    symbol = message.symbol
-
-    # 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.from_protobuf.message_to_expression import (
-        message_to_expression,
-    )
-
-    return Element(label=symbol, parent=message_to_expression(parent), uuid=id)

jijmodeling/protobuf/from_protobuf/message_to_expression.py

@@ -1,92 +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 Expression
-from jijmodeling.expression.variables.variable import Range
-from jijmodeling.protobuf.from_protobuf.message_to_array_shape import (
-    message_to_array_shape,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_binary_op import message_to_binary_op
-from jijmodeling.protobuf.from_protobuf.message_to_binary_var import (
-    message_to_binary_var,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_element import message_to_element
-from jijmodeling.protobuf.from_protobuf.message_to_integer_var import (
-    message_to_integer_var,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_jagged_array import (
-    message_to_jagged_array,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_number_lit import (
-    message_to_number_lit,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_placeholder import (
-    message_to_placeholder,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_reduction_op import (
-    message_to_reduction_op,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_subscript_op import (
-    message_to_subscript_op,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_unary_op import message_to_unary_op
-
-
-def message_to_expression(
-    expression: pb.Expression,
-) -> Union[Expression, Range, Condition]:
-    """
-    Convert a message object to a `Expression` object.
-
-    Args:
-        expression (pb.Expression): a `Expression` message
-
-    Raises:
-        RuntimeError: the error occurs if the massage cannot be converted to an object that is a subclass of the `Expression` class
-
-    Returns:
-        Expression: an instance object that is a subclass of the `Expression` class
-    """
-    # Get the id that the message has.
-    id = expression.id
-
-    # Get the `Expression` object from the field inside the oneof.
-    expr_attr = pb.betterproto.which_one_of(expression.kind, "kind")[1]
-
-    if type(expr_attr) is pb.NumberLit:
-        return message_to_number_lit(id, expr_attr)
-    elif type(expr_attr) is pb.Placeholder:
-        shape = expression.children
-        return message_to_placeholder(id, expr_attr, shape)
-    elif type(expr_attr) is pb.ArrayShape:
-        array = expression.children[0]
-        return message_to_array_shape(id, expr_attr, array)
-    elif type(expr_attr) is pb.Element:
-        parent = expression.children[0]
-        return message_to_element(id, expr_attr, parent)
-    elif type(expr_attr) is pb.JaggedArray:
-        return message_to_jagged_array(id, expr_attr)
-    elif type(expr_attr) is pb.BinaryVar:
-        shape = expression.children
-        return message_to_binary_var(id, expr_attr, shape)
-    elif type(expr_attr) is pb.IntegerVar:
-        return message_to_integer_var(id, expr_attr, expression.children)
-    elif type(expr_attr) is pb.UnaryOp:
-        operand = expression.children[0]
-        return message_to_unary_op(id, expr_attr, operand)
-    elif type(expr_attr) is pb.BinaryOp:
-        left = expression.children[0]
-        right = expression.children[1]
-        return message_to_binary_op(id, expr_attr, left, right)
-    elif type(expr_attr) is pb.SubscriptOp:
-        return message_to_subscript_op(id, expr_attr, expression.children)
-    elif type(expr_attr) is pb.ReductionOp:
-        return message_to_reduction_op(id, expr_attr, expression.children)
-    else:
-        raise RuntimeError(
-            f"cannot convert the {expr_attr.__class__.__name__} object into the instance object according to the class in JijModeling"
-        )

jijmodeling/protobuf/from_protobuf/message_to_forall.py

@@ -1,33 +0,0 @@
-from __future__ import annotations
-
-from typing import Optional, Tuple
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.condition import Condition
-from jijmodeling.expression.variables.variable import Element
-from jijmodeling.protobuf.from_protobuf.message_to_expression import (
-    message_to_expression,
-)
-
-
-def message_to_forall(forall: pb.Forall) -> Tuple[Element, Optional[Condition]]:
-    """
-    Convert a `Forall` message into a `forall` object.
-
-    Args:
-        forall (pb.Forall): a `Forall` message
-
-    Returns:
-        Tuple[Element, Optional[Condition]]: objects to make the `forall` object
-    """
-    # Set the element.
-    element = message_to_expression(forall.element)
-
-    # Set the condition expression.
-    is_none_condition = (
-        pb.betterproto.which_one_of(forall.condition.kind, "kind")[1] is None
-    )
-    condition = None if is_none_condition else message_to_expression(forall.condition)
-
-    return (element, condition)

jijmodeling/protobuf/from_protobuf/message_to_integer_var.py

@@ -1,54 +0,0 @@
-from __future__ import annotations
-
-from typing import List
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.deci_vars import Integer
-
-
-def message_to_integer_var(
-    id: str, message: pb.IntegerVar, children: List[pb.Expression]
-) -> Integer:
-    """
-    Convert a message to an `Integer` object.
-
-    Args:
-        id (str): the id of the `Integer` object
-        message (pb.IntegerVar): the `IntegerVar` message
-        children (List[pb.Expression]): 0: lower bound, 1: upper bound, 2..: the shape of the `Integer` object
-
-    Raises:
-        ValueError: the error occurs if `dim` is not equal to length of the shape
-
-    Returns:
-        Integer: an `Integer` object
-    """
-    # Validate length of the shape.
-    if message.dim + 2 != len(children):
-        raise ValueError("invalid length of the shape")
-
-    # Set the symbol.
-    symbol = message.symbol
-
-    # 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.from_protobuf.message_to_expression import (
-        message_to_expression,
-    )
-
-    # Set the lower.
-    lower = message_to_expression(children[0])
-
-    # Set the upper.
-    upper = message_to_expression(children[1])
-
-    # Set the shape.
-    shape_element_list = [
-        message_to_expression(shape_element) for shape_element in children[2:]
-    ]
-
-    return Integer(
-        label=symbol, lower=lower, upper=upper, shape=shape_element_list, uuid=id
-    )

jijmodeling/protobuf/from_protobuf/message_to_jagged_array.py

@@ -1,25 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.jagged_array import JaggedArray
-
-
-def message_to_jagged_array(id: str, message: pb.JaggedArray) -> JaggedArray:
-    """
-    Convert a message to a `JaggedArray` object.
-
-    Args:
-        id (str): the id of the `JaggedArray` object
-        message (pb.JaggedArray): the `JaggedArray` message
-
-    Returns:
-        JaggedArray: a `JaggedArray` object
-    """
-    # Set the symbol.
-    symbol = message.symbol
-
-    # Set the number of dimensions.
-    dim = message.dim
-
-    return JaggedArray(label=symbol, dim=dim, uuid=id)

jijmodeling/protobuf/from_protobuf/message_to_number_lit.py

@@ -1,41 +0,0 @@
-from __future__ import annotations
-
-import struct
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.expression import DataType, Number
-
-
-def message_to_number_lit(id: str, message: pb.NumberLit) -> Number:
-    """
-    Convert a message to a `Number` object.
-
-    Args:
-        message (pb.NumberLit): the `NumberLit` message
-        id (str): the id of the `Number` object
-
-    Returns:
-        Number: a `Number` object
-    """
-    # Check the type that the number literal object has.
-    # Case: integer
-    if message.type == pb.NumberLitType.INTEGER:
-        # Set the value type to `FLOAT`.
-        dtype = DataType.INT
-        # Set the integer value.
-        value = struct.unpack(
-            ">q",
-            message.value.to_bytes(length=struct.calcsize(">q"), byteorder="big"),
-        )[0]
-    # Case: float
-    elif message.type == pb.NumberLitType.FLOAT:
-        # Set the value type to `FLOAT`.
-        dtype = DataType.FLOAT
-        # Convert the bits to a float value.
-        value = struct.unpack(
-            ">d",
-            message.value.to_bytes(length=struct.calcsize(">d"), byteorder="big"),
-        )[0]
-
-    return Number(value=value, dtype=dtype, uuid=id)

jijmodeling/protobuf/from_protobuf/message_to_penalty.py

@@ -1,36 +0,0 @@
-from __future__ import annotations
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.constraint import Penalty
-from jijmodeling.protobuf.from_protobuf.message_to_expression import (
-    message_to_expression,
-)
-from jijmodeling.protobuf.from_protobuf.message_to_forall import message_to_forall
-
-
-def message_to_penalty(penalty: pb.Penalty) -> Penalty:
-    """
-    Convert a `Penalty` message into a `Penalty` object.
-
-    Args:
-        penalty (pb.Penalty): a `Penalty` message
-
-    Returns:
-        Penalty: a `Penalty` object
-    """
-    # Set the name of the penalty.
-    name = penalty.name
-
-    # Set the penalty term.
-    expr = message_to_expression(penalty.expression)
-
-    # Set the list of forall.
-    forall = [message_to_forall(forall) for forall in penalty.forall]
-
-    return Penalty(
-        label=name,
-        penalty_term=expr,
-        forall=forall,
-        with_multiplier=penalty.needs_multiplier,
-    )

jijmodeling/protobuf/from_protobuf/message_to_placeholder.py

@@ -1,47 +0,0 @@
-from __future__ import annotations
-
-from typing import List
-
-import jijmodeling_schema as pb
-
-from jijmodeling.expression.variables.placeholders import Placeholder
-
-
-def message_to_placeholder(
-    id: str, message: pb.Placeholder, shape: List[pb.Expression]
-) -> Placeholder:
-    """
-    Convert a message to a `Placeholder` object.
-
-    Args:
-        id (str): the id of the `Placeholder` object
-        message (pb.Placeholder): the `Placeholder` message
-        shape (List[pb.Expression]): the shape of the `Placeholder` object
-
-    Returns:
-        Placeholder: a `Placeholder` object
-    """
-    # Set the symbol.
-    symbol = message.symbol
-
-    # Set the number of dimensions.
-    dim = message.dim
-
-    # Set the shape.
-    shape_list = []
-    expr_idx = 0
-    for shape_elt in message.shape:
-        if shape_elt == pb.PlaceholderShapeElement.DYNAMIC:
-            shape_list.append(None)
-        else:
-            # 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.from_protobuf.message_to_expression import (
-                message_to_expression,
-            )
-
-            shape_list.append(message_to_expression(shape[expr_idx]))
-            expr_idx = expr_idx + 1
-
-    return Placeholder(label=symbol, dim=dim, uuid=id, shape=shape_list)