rl.env.state Namespace Reference

Classes
class	Beluga
	Container ship (Beluga) with current and outgoing jigs. More...
class	Jig
	Individual jig instance with type and status. More...
class	JigType
	Represents a type of jig with size properties. More...
class	ProblemState
	Complete state representation for the Beluga Challenge. More...
class	ProductionLine
	Factory production line with scheduled jigs. More...
class	Rack
	Storage rack with size constraints. More...

Functions
int	extract_id (str name)
	Extract numeric ID from jig name string.
str	get_name_from_id (int id)
	Generate jig name from numeric ID.
JigType|None	get_type (str name)
	Get JigType instance from type name string.
ProblemState	load_from_json (path)
	Load problem state from JSON file.

Function Documentation

extract_id()

int rl.env.state.extract_id

(

str

name

)

Extract numeric ID from jig name string.

Parameters

name	Jig name in format "jigXXXX"

Returns

Integer ID (0-based indexing)

def extract_id(name: str) -> int:
    """!
    @brief Extract numeric ID from jig name string
    @param name Jig name in format "jigXXXX"
    @return Integer ID (0-based indexing)
    """
    name = name.replace("jig", "")
    return int(name) - 1
 

get_name_from_id()

str rl.env.state.get_name_from_id

(

int

id

)

Generate jig name from numeric ID.

Parameters

id	Integer ID (0-based)

Returns

Jig name in format "jigXXXX"

def get_name_from_id(id: int) -> str:
    """!
    @brief Generate jig name from numeric ID
    @param id Integer ID (0-based)
    @return Jig name in format "jigXXXX"
    """
    return "jig" + "0" * (4-len(str(id))) + str(id)
 
 

get_type()

JigType | None rl.env.state.get_type

(

str

name

)

Get JigType instance from type name string.

Parameters

name	Type name (typeA, typeB, typeC, typeD, or typeE)

Returns

JigType instance with appropriate size properties, or None if unknown

def get_type(name: str) -> JigType | None:
    """!
    @brief Get JigType instance from type name string
    @param name Type name (typeA, typeB, typeC, typeD, or typeE)
    @return JigType instance with appropriate size properties, or None if unknown
    """
    if name == "typeA":
        return JigType("typeA", 4, 4)
    elif name == "typeB":
        return JigType("typeB", 8, 11)
    elif name == "typeC":
        return JigType("typeC", 9, 18)
    elif name == "typeD":
        return JigType("typeD", 18, 25)
    elif name == "typeE":
        return JigType("typeE", 32, 32)
    return None
 

load_from_json()

ProblemState rl.env.state.load_from_json

(

path

)

Load problem state from JSON file.

Parameters

path	Path to the JSON problem file

Returns

ProblemState instance loaded from the file

Parses the JSON problem definition and creates all necessary objects (jigs, belugas, racks, production lines, etc.)

def load_from_json(path) -> ProblemState:
    """!
    @brief Load problem state from JSON file
    @param path Path to the JSON problem file
    @return ProblemState instance loaded from the file
    
    Parses the JSON problem definition and creates all necessary
    objects (jigs, belugas, racks, production lines, etc.)
    """
 
    data = open(path, "r")
    dictionary = json.loads(data.read())
    data.close()
 
    jig_data = dictionary["jigs"]
 
    jigs: list[Jig] = []
    for jig_n, jig in jig_data.items():
        jigs.append(Jig(get_type(jig["type"]), jig["empty"]))
 
    beluga_data = dictionary["flights"]
    belugas: list[Beluga] = []
    for beluga in beluga_data:
        incoming: list[int] = []
        outgoing: list[JigType] = []
        for entry in beluga["incoming"]:
            incoming.append(extract_id(entry))
        for entry in beluga["outgoing"]:
            outgoing.append(get_type(entry))
        belugas.append(Beluga(incoming, outgoing))
 
    production_lines_data = dictionary["production_lines"]
    production_lines: list[ProductionLine] = []
    for production_line in production_lines_data:
        schedule: list[int] = []
        for entry in production_line["schedule"]:
            schedule.append(extract_id(entry))
        production_lines.append(ProductionLine(schedule))
 
    racks_data = dictionary["racks"]
    racks: list[Rack] = []
    for rack in racks_data:
        storage: list[int] = []
        for entry in rack["jigs"]:
            storage.append(extract_id(entry))
        racks.append(Rack(rack["size"], storage))
 
    hangars: list[Jig | None] = [None] * len(dictionary["hangars"])
    trailers_beluga: list[Jig | None] = [None] * len(dictionary["trailers_beluga"])
    trailers_factory: list[Jig | None] = [None] * len(dictionary["trailers_factory"])
 
    
    return ProblemState(jigs, belugas, trailers_beluga, trailers_factory, racks, production_lines, hangars)