rl.env.state.Beluga Class Reference

Container ship (Beluga) with current and outgoing jigs. More...

Public Member Functions
	__init__ (self, list[int] current_jigs, list[JigType] outgoing)
	Initialize a Beluga ship.
	__str__ (self)
	copy (self)
	Create a deep copy of this Beluga.

Public Attributes
	current_jigs = current_jigs
	outgoing = outgoing

Detailed Description

Container ship (Beluga) with current and outgoing jigs.

Represents a ship that can carry jigs. Has current jigs aboard and a list of outgoing jig types that need to be loaded.

Constructor & Destructor Documentation

__init__()

rl.env.state.Beluga.__init__	(		self,
		list[int]	current_jigs,
		list[JigType]	outgoing )

Initialize a Beluga ship.

Parameters

current_jigs	List of jig IDs currently on the ship
outgoing	List of jig types that need to be loaded onto this ship

    def __init__(self, current_jigs: list[int], outgoing: list[JigType]):
        """!
        @brief Initialize a Beluga ship
        @param current_jigs List of jig IDs currently on the ship
        @param outgoing List of jig types that need to be loaded onto this ship
        """
        self.current_jigs = current_jigs
        self.outgoing = outgoing
 

Member Function Documentation

__str__()

rl.env.state.Beluga.__str__

(

self

)

    def __str__(self):
        return "current_jigs = " + str(self.current_jigs) + " | outgoing = " + str(self.outgoing)
    

copy()

rl.env.state.Beluga.copy

(

self

)

Create a deep copy of this Beluga.

Returns

New Beluga instance with same properties

    def copy(self):
        """!
        @brief Create a deep copy of this Beluga
        @return New Beluga instance with same properties
        """
        # current_jigs and outgoing are lists of ints/objects → shallow copy suffices
        return Beluga(self.current_jigs[:], self.outgoing[:])
 
 

Member Data Documentation

current_jigs

rl.env.state.Beluga.current_jigs = current_jigs

outgoing

rl.env.state.Beluga.outgoing = outgoing

---

The documentation for this class was generated from the following file:

• rl/env/state.py