---
name: "LaTeXML::Core::Definition::Register"
section: "3pm"
platform: "linux"
package: "latexml"
version: "0.8.8-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/LaTeXML::Core::Definition::Register"
---

# LaTeXML::Core::Definition::Register(3pm)

Control sequence definitions for Registers.

## NAME

"LaTeXML::Core::Definition::Register"  - Control sequence definitions for Registers.

## DESCRIPTION

These are set up as a speciallized primitive with a getter and setter to access and store values in the Stomach. See LaTeXML::Package for the most convenient means to create them.

It extends LaTeXML::Core::Definition::Primitive.

Registers generally store some value in the current `"LaTeXML::Core::State"`, but are not required to. Like TeX's registers, when they are digested, they expect an optional `"="`, and then a value of the appropriate type. Register definitions support these additional methods:

## Methods

- "$value = $register-\>valueOf(@args);"

  Return the value associated with the register, by invoking it's `"getter"` function. The additional args are used by some registers to index into a set, such as the index to `"\count"`.

- "$register-\>setValue($value,$scope,@args);"

  Assign a value to the register, by invoking it's `"setter"` function.

## AUTHOR

Bruce Miller \<bruce.miller@nist.gov\>

## COPYRIGHT

Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.