Package Org.Rl-Community.Rl-Glue-Codec - internal and external symbols

Part of:

asdf-system rl-glue-utils, asdf-system rl-glue-codec
See only external symbols
Package Org.Rl-Community.Rl-Glue-Codec uses the packages Common-Lisp and Usocket. It is also known as Rl-Glue-Codec. It has 231 total symbols and 40 external ones.

Condition

empty-buffer-errorRaised if there is not enough data
to read an object of OTYPE.

Class

actionGeneral RL-Glue action data representation.
agentThe RL-Glue agent.
environmentThe RL-Glue environment.
experimentThe RL-Glue experiment.
observationGeneral RL-Glue observation data representation.
rl-abstract-typeGeneral RL-Glue data representation.

Variable

*init-buffer-size*Initial buffer size in bytes.
*init-float-array*An empty array typed by the package supported floating point numbers.
*init-integer-array*An empty array typed by the package supported integer numbers.
*optimize-settings*General optimization settings of the package.
+k-default-port+Default port on which connection is tried to the rl-glue server.
+k-localhost+IP address of the local host.
+k-retry-timeout+Default timeout seconds between two connection attempts.

Constant

+bits-per-byte+Number of bits in a byte.
+bits-per-char+Number of bits in the character type.
+bits-per-float+Number of bits in the floating point type.
+bits-per-integer+Number of bits in the integer type.
+bits-per-short+Number of bits in a short.
+bytes-per-char+Number of bytes in the character type.
+bytes-per-float+Number of bytes in the floating point type.
+bytes-per-integer+Number of bytes in the integer type.
+expo-bits+Number of bits in the exponent part of the floating point type.
+expo-offset+Exponent offset for floating point encoding/decoding.
+k-agent-cleanup+Network code of agent cleanup event.
+k-agent-connection+Network code of agent connection establishment event.
+k-agent-end+Network code of agent episode end event.
+k-agent-freeze+Network code of agent freeze event (deprecated and ignored).
+k-agent-init+Network code of agent initialization event.
+k-agent-message+Network code of agent message sending event.
+k-agent-start+Network code of agent start event.
+k-agent-step+Network code of agent step event.
+k-env-cleanup+Network code of environment cleanup event.
+k-env-init+Network code of environment initialization event.
+k-env-load-random-seed+Network code of environment random seed loading event
(deprecated and ignored).
+k-env-load-state+Network code of environment state loading event
(deprecated and ignored).
+k-env-message+Network code of environment message sending event.
+k-env-save-random-seed+Network code of environment random seed saving event
(deprecated and ignored).
+k-env-save-state+Network code of environment state saving event
(deprecated and ignored).
+k-env-start+Network code of environment start event.
+k-env-step+Network code of environment step event.
+k-environment-connection+Network code of environment connection establishment event.
+k-experiment-connection+Network code of experiment connection establishment event.
+k-rl-agent-message+Network code of experiment message sending to agent event.
+k-rl-cleanup+Network code of experiment cleanup event.
+k-rl-env-message+Network code of experiment message sending to environment event.
+k-rl-episode+Network code of experiment episode running event.
+k-rl-freeze+Network code of experiment freeze event
(deprecated and ignored).
+k-rl-init+Network code of experiment initialization event.
+k-rl-load-random-seed+Network code of experiment random seed loading event
(deprecated and ignored).
+k-rl-load-state+Network code of experiment state loading event
(deprecated and ignored).
+k-rl-numepisodes+Network code of experiment number of episodes query event.
+k-rl-numsteps+Network code of experiment number of steps query event.
+k-rl-return+Network code of experiment total reward query event.
+k-rl-save-random-seed+Network code of experiment random seed saving event
(deprecated and ignored).
+k-rl-save-state+Network code of experiment state saving event
(deprecated and ignored).
+k-rl-start+Network code of experiment start event.
+k-rl-step+Network code of experiment step event.
+k-rl-term+Network code of experiment termination event.
+max-sigd+Maximum significand value of the floating point type.
+sigd-bits+Number of bits in the significand part of the floating point type.
+uint-limit+Maximum unsigned integer value.
+uint-minneg+Minimum unsigned integer value which is a negative singed.

Function

auto-adjustChecks whether the buffer has enough free space to store SIZE bytes.
If not, it automatically ad...
buffer-bytesReturns the storage (byte array) of the buffer.
buffer-clearClears the content of BUFFER.
buffer-offsetReturns the pointer of the buffer from/to read/write happens.
buffer-pReturns T if type if OBJECT is buffer.
buffer-read-charReads a character from BUFFER.
buffer-read-floatReads a float from BUFFER.
buffer-read-float-seqReads a float sequence from BUFFER.
buffer-read-intReads an integer from BUFFER.
buffer-read-int-seqReads an integer sequence from BUFFER.
buffer-read-stringReads a string (character sequence) from BUFFER.
buffer-recvReceiving the size and the bytes to BUFFER from STREAM.
buffer-sendSending the TARGET, the size and the bytes from BUFFER to STREAM.
buffer-sizeReturns the number of (used) bytes in the buffer.
buffer-write-charWrites the CH character to BUFFER.
buffer-write-floatWrites the FLOAT float to BUFFER.
buffer-write-float-seqWrites the FLOAT-SEQ float sequence to BUFFER.
buffer-write-intWrites the INTEGER integer to BUFFER.
buffer-write-int-seqWrites the INT-SEQ integer sequence to BUFFER.
buffer-write-stringWrites the STRING character sequence to BUFFER.
char-decoderReturns the decoded character of CODE.
char-encoderReturns the code of CH.
copy-bufferReturn a copy of STRUCTURE with the same (EQL) slot values.
emit-empty-buffer-errorEmits an empty-buffer-error with a use-value restart option.
float-decoderReturns the float generated from the L-CODE and R-CODE codes.
float-encoderReturns the codes of FLOAT.
forced-formatWrites to the standard output without any delay.
get-codec-versionReturns the official codec version.
get-vc-codec-versionReturns the codec version in the version control system.
integer-decoderReturns the decoded sigend integer of CODE.
integer-encoderReturns the code of INT.
make-actionMakes an empty action object.
make-bufferMakes an unsigned byte based data buffer.
make-float-arrayMakes a float array of SIZE with the package supported floating point
typed elements.
make-int-arrayMakes an integer array of SIZE with the package supported integer
typed elements.
make-observationMakes an empty observation object.
make-typed-arrayMakes an array of SIZE with elements of TYPE.
on-agent-cleanupHandles the buffer operations for agent-cleanup.
on-agent-endHandles the buffer operations for agent-end.
on-agent-initHandles the buffer operations for agent-init.
on-agent-messageHandles the buffer operations for agent-message.
on-agent-startHandles the buffer operations for agent-start.
on-agent-stepHandles the buffer operations for agent-step.
on-env-cleanupHandles the buffer operations for env-cleanup.
on-env-initHandles the buffer operations for env-init.
on-env-messageHandles the buffer operations for env-message.
on-env-startHandles the buffer operations for env-start.
on-env-stepHandles the buffer operations for env-step.
read-intReturns a read integer from STREAM.
rl-agent-messageThis message passes the input string to the agent and returns the
reply string given by the age...
rl-cleanupProvides an opportunity to reclaim resources allocated by rl-init.

PARAMETERS:
exp : expe...
rl-closeFinishes the experiment by closing its network resources (socket).

PARAMETERS:
exp : expe...
rl-close-socketCloses the given socket.
rl-env-messageThis message passes the input string to the environment and returns the
reply string given by t...
rl-episodeDo one episode until a termination observation occurs or until steps have
elapsed, whichever co...
rl-initThis initializes everything, passing the environment's task specification
to the agent. This sh...
rl-num-episodesReturn the number of episodes finished after rl-init.

PARAMETERS:
exp : experiment in use...
rl-num-stepsReturn the number of steps elapsed in the current or just completed episode.

PARAMETERS:
...
rl-read-actionReads an action object from BUFFER.
rl-read-messageReads a message string from BUFFER.
rl-read-observationReads an observation object from BUFFER.
rl-read-rewardReads a reward value from BUFFER.
rl-read-task-specReads a task specification string from BUFFER.
rl-read-terminalReads a terminal indicator boolean from BUFFER.
rl-recv-bufferReceives the BUFFER content and a state identifier what is returned.
rl-returnReturn the cumulative total reward of the current or just completed episode.
The collection of ...
rl-runnerConnects and runs the loop of OBJ.
rl-send-bufferSends the BUFFER content with STATE identifier.
rl-startDo the first step of a run or episode. The action is saved in
the upcoming-action slot so that ...
rl-stepTake one step. rl-step uses the saved action and saves the returned
action for the next step. T...
rl-wait-for-connectionWaiting for a connection to be established. Returns the obtained socket
descriptor on success, o...
rl-write-actionWrites ACTION object into BUFFER.
rl-write-messageWrites MESSAGE string into BUFFER.
rl-write-observationWrites OBSERVATION object into BUFFER.
rl-write-rewardWrites REWARD value into BUFFER.
rl-write-task-specWrites TASK-SPEC task specification string into BUFFER.
rl-write-terminalWrites TERMINAL terminal indicator boolean into BUFFER.
run-agentConnects the specified AGENT to RL-Glue on HOST and PORT. If the
attempt is refused, it is tried...
run-agent-event-loopCommunication loop of an agent with the rl-glue server.
run-envConnects the specified ENV to RL-Glue on HOST and PORT. If the
attempt is refused, it is tried ...
run-env-event-loopCommunication loop of an environment with the rl-glue server.
write-intWrites an integer to STREAM.

Generic-Function

otype
rl-equalpCompares two RL objects.
rl-readReads an object from BYTE-STREAM.
rl-writeWrites an object to BYTE-STREAM.

Macro

buffer-readReads an encoded value (CODE) from BUFFER, where SIZE is the length
of the encoded value in byte...
buffer-read-seqRead a sequence of elements with type ELEM-TYPE and size ELEM-SIZE from
BUFFER by the READER-FN ...
buffer-writeWrites an encoded value (CODE) to BUFFER, where SIZE is the length
of the encoded value in bytes...
buffer-write-seqWrite the SEQ sequence of elements with type ELEM-TYPE and size ELEM-SIZE to
BUFFER by the WRITE...
with-empty-buffer-checkChecks whether there is enough bytes in BUFFER to read an object of TYPE.