Skip to content
Topaz6.0 · Before release
Download

Search documentation

Specification 6.0 · Not released · Tested product 5.21.3

Use arrow keys to choose a result. Press Enter to open.

Type an API name, diagnostic number, rule, or project topic.

    Library · std.typeset

    Length.toMm for In

    Expresses a physical length in millimeters.

    toMm() -> Length<Mm>
    Receiver
    Length<In>
    Minimum arity
    0
    Maximum arity
    0

    Declaration and parameters

    Link

    Availability

    Included by default: Pending

    Import std.typeset in language mode 5.21.

    The current compiler selects std/typeset.tpz for this language mode. Availability in other released editions and inclusion in each installed distribution are Pending.

    Source evidence

    Receiver

    Length<In>

    Parameter constraints

    Every physical Length stores a signed 64-bit scaled-point count and a unit marker. The inclusive count range is -9223372036854775808 through 9223372036854775807. Zero and negative lengths are valid.

    One point is 65,536 scaled points. One inch is 72 points and exactly 25.4 millimetres. One centimetre is 10 millimetres.

    A physical literal converts its exact decimal value to scaled points and rounds once to the nearest integer. An exact tie selects the even integer. The same rule applies to either sign.

    The methods toPt, toMm, toCm, and toIn accept no arguments on Length<Pt>, Length<Mm>, Length<Cm>, and Length<In>. They return the named physical unit with the original scaled-point count.

    A unit conversion performs no further rounding and cannot overflow. Converting to the existing unit returns the same typed value. Every conversion sequence preserves the physical distance and stored count.

    The unit marker remains part of the static type. Assignment and function arguments do not convert units implicitly. A required Length<Pt> rejects another unit with TPZ5001. Convert explicitly before the call or assignment.

    Length<Em> has no physical conversion member. Resolve it with an explicit positive point font size before converting units.

    Each method evaluates its receiver once before producing the result. Conversion performs no I/O or mutation and reads no font or paragraph state.

    Use toScaledPoints on any physical unit for the exact stored integer. Convert to Length<Pt> before calling toMilliPoints. The integer conversion contract defines its separate rounding boundary.

    Result

    The declared result type is Length<Mm>.

    Effects

    Failures

    Result and effects

    Link

    Return Length<Mm> with the exact stored scaled-point count. This accepts the full signed Length range, including zero and negative values. The conversion does not round, overflow, or consult a font.

    Why

    Link

    A physical unit belongs to the length type. Explicit conversion changes the unit marker while preserving the physical distance and its scaled-point grid value.

    Resolved contracts

    Link

    Related entries

    Link

    std.typeset

    Convert physical units without rounding again

    Link

    Convert physical units without rounding again

    Every physical Length stores a signed 64-bit scaled-point count and a unit marker. The inclusive count range is -9223372036854775808 through 9223372036854775807. Zero and negative lengths are valid.

    One point is 65,536 scaled points. One inch is 72 points and exactly 25.4 millimetres. One centimetre is 10 millimetres.

    A physical literal converts its exact decimal value to scaled points and rounds once to the nearest integer. An exact tie selects the even integer. The same rule applies to either sign.

    The methods toPt, toMm, toCm, and toIn accept no arguments on Length<Pt>, Length<Mm>, Length<Cm>, and Length<In>. They return the named physical unit with the original scaled-point count.

    A unit conversion performs no further rounding and cannot overflow. Converting to the existing unit returns the same typed value. Every conversion sequence preserves the physical distance and stored count.

    The unit marker remains part of the static type. Assignment and function arguments do not convert units implicitly. A required Length<Pt> rejects another unit with TPZ5001. Convert explicitly before the call or assignment.

    Length<Em> has no physical conversion member. Resolve it with an explicit positive point font size before converting units.

    Each method evaluates its receiver once before producing the result. Conversion performs no I/O or mutation and reads no font or paragraph state.

    Use toScaledPoints on any physical unit for the exact stored integer. Convert to Length<Pt> before calling toMilliPoints. The integer conversion contract defines its separate rounding boundary.

    Why

    A unit marker states how a length may be used while one physical grid preserves its distance. Conversion changes the marker without accumulating rounding error. One conversion name per target unit works for every physical source unit.

    Source evidence

    Convert each physical unit to every physical target

    Link
    main.tpzConvert each physical unit to every physical targetOpen in Playground
    1. import std.io
    2. let pt = 72pt
    3. let mm = 25.4mm
    4. let cm = 2.54cm
    5. let inch = 1in
    6. io.writeLine("{pt.toPt() == 72pt}|{pt.toMm() == 25.4mm}|{pt.toCm() == 2.54cm}|{pt.toIn() == 1in}")
    7. io.writeLine("{mm.toPt() == 72pt}|{mm.toMm() == 25.4mm}|{mm.toCm() == 2.54cm}|{mm.toIn() == 1in}")
    8. io.writeLine("{cm.toPt() == 72pt}|{cm.toMm() == 25.4mm}|{cm.toCm() == 2.54cm}|{cm.toIn() == 1in}")
    9. io.writeLine("{inch.toPt() == 72pt}|{inch.toMm() == 25.4mm}|{inch.toCm() == 2.54cm}|{inch.toIn() == 1in}")
    Expected outputexit 0
    true|true|true|true
    true|true|true|true
    true|true|true|true
    true|true|true|true
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. true|true|true|true
    2. true|true|true|true
    3. true|true|true|true
    4. true|true|true|true
    Source evidence

    Preserve signed and quantized values through conversion chains

    Link
    main.tpzPreserve signed and quantized values through conversion chainsOpen in Playground
    1. import std.typeset as ts
    2. import std.io
    3. let negative = (-1pt).toMm().toCm().toIn().toPt()
    4. let zero = (0mm).toIn().toPt()
    5. let metric = (0.1mm).toPt()
    6. let unchanged = metric.toCm().toMm().toIn().toPt()
    7. io.writeLine("{negative == -1pt}|{zero == 0pt}|{metric == ts.fromScaledPoints(18577)}|{unchanged == ts.fromScaledPoints(18577)}")
    Expected outputexit 0
    true|true|true|true
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. true|true|true|true
    Source evidence

    Keep the full range when changing units

    Link
    main.tpzKeep the full range when changing unitsOpen in Playground
    1. import std.typeset as ts
    2. import std.io
    3. let low = ts.fromScaledPoints(-9223372036854775808).toMm().toCm().toIn().toPt()
    4. let high = ts.fromScaledPoints(9223372036854775807).toIn().toCm().toMm().toPt()
    5. io.writeLine("{low == -140737488355328pt}|{high == 140737488355327.9999847412109375pt}")
    Expected outputexit 0
    true|true
    
    $ topaz run main.tpz · target product 5.21.3
    Expected result

    Expected result

    Execution completes. Exit code 0.

    Expected stdout
    1. true|true
    Source evidence

    Require the declared physical unit after conversion

    Link
    main.tpzRequire the declared physical unit after conversionOpen in Playground
    1. let distance: Length<Pt> = (1pt).toMm()
    Expected outputNonzero exit
    No stdout.
    $ topaz check main.tpz --format json · target product 5.21.3
    Expected result

    Expected result

    Rejection during check. Nonzero exit.

    • TPZ5001 stdlib-physical-distance-requires-points at main.tpz:1:28
    Source evidence

    Diagnostics

    Link

    TPZ5001

    Menu

    Download