#!/usr/bin/env dub
/+ dub.sdl:
name "uom_quantity_diagnostics"
targetPath "build"
+/
/**
* Units of measure — engineered domain-language diagnostics for a raytracer.
*
* The single sharpest adoption tax on static units libraries is *encoding
* leakage*: a mismatch prints the mangled template payload — here a bare
* `Quantity!(Dim(1, 0, -3, -1), …)` struct literal — instead of the sentence a
* physicist would say. mp-units and Au answer this by treating diagnostics as a
* product: prose (and even doc URLs) baked into `static_assert` text, plus a
* type/dimension pretty-printer. This prototype ports that stance to D. A CTFE
* pretty-printer `unitString` renders a dimension's exponent vector as SI base
* symbols (`kg·s⁻³·sr⁻¹`), and a `checkAddable!(A, B)` template turns a
* dimension clash into the raytracer's own vocabulary:
* *"cannot add Radiance [W·m⁻²·sr⁻¹] to Irradiance [W·m⁻²] — dimensions differ"*.
* A module-scope `pragma(msg, …)` prints that engineered sentence at compile
* time next to the raw leaked type name, so the reader SEES the contrast without
* the build failing — the real mismatch stays quarantined behind a passing
* `static assert(!__traits(compiles, …))`.
*
* The raytracer framing gives the messages teeth: `Radiance` (W·m⁻²·sr⁻¹) and
* `Irradiance` (W·m⁻²) differ only by a solid-angle exponent, exactly the
* confusion a rendering-equation implementation must never make silently.
*
* Companion to docs/research/units-of-measure/comparison.md § 6 "Diagnostics and
* compile cost", and to ./cpp-au.md, ./cpp-mp-units.md, ./d-quantities.md (the
* "messages are a feature" exemplars and D's first-line-readability prior art).
*
* Composition: this file is scalar — the diagnostic lives entirely in the CTFE
* `Dim` value and the type's compile-time labels, so it is orthogonal to the
* numeric payload. Wrapping a `sparkles:math` `Vector` would use composition
* *ordering A* (`Quantity!(dim, Vec3)`, as in `quantity-affine-torsor.d`): the
* dimension, its labels, and `checkAddable` are unchanged, and a `Vec3` payload
* only alters `toString`'s value rendering — the engineered prose is payload-blind.
*
* Run with: `dub run --single quantity-diagnostics.d`
*/
module (module) uom_quantity_diagnosticsUnits of measure — engineered domain-language diagnostics for a raytracer.
The single sharpest adoption tax on static units libraries is encoding
leakage: a mismatch prints the mangled template payload — here a bare
Quantity!(Dim(1, 0, -3, -1), …) struct literal — instead of the sentence a
physicist would say. mp-units and Au answer this by treating diagnostics as a
product: prose (and even doc URLs) baked into static_assert text, plus a
type/dimension pretty-printer. This prototype ports that stance to D. A CTFE
pretty-printer unitString renders a dimension's exponent vector as SI base
symbols (kg·s⁻³·sr⁻¹), and a checkAddable!(A, B) template turns a
dimension clash into the raytracer's own vocabulary:
"cannot add Radiance W·m⁻²·sr⁻¹ to Irradiance W·m⁻² — dimensions differ".
A module-scope pragma(msg, …) prints that engineered sentence at compile
time next to the raw leaked type name, so the reader SEES the contrast without
the build failing — the real mismatch stays quarantined behind a passing
static assert(!__traits(compiles, …)).
The raytracer framing gives the messages teeth: Radiance (W·m⁻²·sr⁻¹) and
Irradiance (W·m⁻²) differ only by a solid-angle exponent, exactly the
confusion a rendering-equation implementation must never make silently.
Companion to docs/research/units-of-measure/comparison.md § 6 "Diagnostics and
compile cost", and to ./cpp-au.md, ./cpp-mp-units.md, ./d-quantities.md (the
"messages are a feature" exemplars and D's first-line-readability prior art).
Composition
this file is scalar — the diagnostic lives entirely in the CTFE
Dim value and the type's compile-time labels, so it is orthogonal to the
numeric payload. Wrapping a sparkles:math Vector would use composition
ordering A (Quantity!(dim, Vec3), as in quantity-affine-torsor.d): the
dimension, its labels, and checkAddable are unchanged, and a Vec3 payload
only alters toString's value rendering — the engineered prose is payload-blind.
Run with: dub run --single quantity-diagnostics.d
uom_quantity_diagnostics;
/// A dimension: an exponent vector in the free abelian group `ℤ⁴` over the base
/// dimensions (mass, length, time, solid angle), stored as its unique normal
/// form. Solid angle is carried as an extra base dimension — the Boost-units
/// "angle as a dimension" choice — precisely so `Radiance` and `Irradiance`,
/// which are SI-dimensionally identical, become distinguishable types.
struct (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim
{
int (field) int uom_quantity_diagnostics.Dim.massmass;
int (field) int uom_quantity_diagnostics.Dim.lengthlength;
int (field) int uom_quantity_diagnostics.Dim.timetime;
int (field) int uom_quantity_diagnostics.Dim.solidAnglesolidAngle;
}
/// The group operation, component-wise: `sign = +1` for multiplication,
/// `sign = -1` for division (the group inverse).
(struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim uom_quantity_diagnostics.Dim uom_quantity_diagnostics.combine(in uom_quantity_diagnostics.Dim a, in uom_quantity_diagnostics.Dim b, in int sign) pure nothrow @nogc @safeThe group operation, component-wise: sign` = +1` for multiplication,
sign = -1 for division (the group inverse).
combine(in (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (parameter) const(uom_quantity_diagnostics.Dim) aa, in (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (parameter) const(uom_quantity_diagnostics.Dim) bb, in int (parameter) const(int) signsign) @safe pure nothrow @nogc
in ((parameter) const(int) signsign == 1 || (parameter) const(int) signsign == -1)
{
return (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim(
mass: (parameter) const(uom_quantity_diagnostics.Dim) aa.(field) int uom_quantity_diagnostics.Dim.massmass + (parameter) const(int) signsign * (parameter) const(uom_quantity_diagnostics.Dim) bb.(field) int uom_quantity_diagnostics.Dim.massmass,
length: (parameter) const(uom_quantity_diagnostics.Dim) aa.(field) int uom_quantity_diagnostics.Dim.lengthlength + (parameter) const(int) signsign * (parameter) const(uom_quantity_diagnostics.Dim) bb.(field) int uom_quantity_diagnostics.Dim.lengthlength,
time: (parameter) const(uom_quantity_diagnostics.Dim) aa.(field) int uom_quantity_diagnostics.Dim.timetime + (parameter) const(int) signsign * (parameter) const(uom_quantity_diagnostics.Dim) bb.(field) int uom_quantity_diagnostics.Dim.timetime,
solidAngle: (parameter) const(uom_quantity_diagnostics.Dim) aa.(field) int uom_quantity_diagnostics.Dim.solidAnglesolidAngle + (parameter) const(int) signsign * (parameter) const(uom_quantity_diagnostics.Dim) bb.(field) int uom_quantity_diagnostics.Dim.solidAnglesolidAngle,
);
}
/// CTFE dimension pretty-printer: renders an exponent vector as SI base symbols
/// joined by middle dots with Unicode superscripts, e.g.
/// `Dim(mass: 1, time: -3, solidAngle: -1)` → `"kg·s⁻³·sr⁻¹"`. The identity
/// renders as `"(dimensionless)"`. GC-allocating, but only ever evaluated at
/// compile time — this is the custom `toString` on the dimension *value* that
/// lets a diagnostic speak base-SI instead of leaking a struct literal.
(alias) object.string = stringstring string uom_quantity_diagnostics.unitString(in uom_quantity_diagnostics.Dim d) pure @safeCTFE dimension pretty-printer: renders an exponent vector as SI base symbols
joined by middle dots with Unicode superscripts, e.g.
Dim(mass: 1, time: -3, solidAngle: -1) → "kg·s⁻³·sr⁻¹". The identity
renders as "(dimensionless)". GC-allocating, but only ever evaluated at
compile time — this is the custom toString on the dimension value that
lets a diagnostic speak base-SI instead of leaking a struct literal.
unitString(in (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (parameter) const(uom_quantity_diagnostics.Dim) dd) @safe pure
{
static immutable (alias) object.string = stringstring[] (immutable global) immutable(string[]) uom_quantity_diagnostics.unitString.supDigitsupDigit =
["⁰", "¹", "²", "³", "⁴", "⁵", "⁶", "⁷", "⁸", "⁹"];
static (alias) object.string = stringstring string uom_quantity_diagnostics.unitString.superscript(int e) pure nothrow @safesuperscript(int (parameter) int ee) @safe pure
{
import (package) stdstd.(module) std.convA one-stop shop for converting values from one type to another.
Category Functions Generic asOriginalType castFrom parse to toChars bitCast Strings text wtext dtext writeText writeWText writeDText hexString Numeric octal roundTo signed unsigned Exceptions ConvException ConvOverflowException
Source
std/conv.d
conv : (alias template) to = std.conv.to(T)The to template converts a value from one type _to another.
The source type is deduced and the target type must be specified, for example the
expression to!int(42.0) converts the number 42 from
double _to int. The conversion is "safe", i.e.,
it checks for overflow; to!int(4.2e10) would throw the
ConvOverflowException exception. Overflow checks are only
inserted when necessary, e.g., to!double(42) does not do
any checking because any int fits in a double.
Conversions from string _to numeric types differ from the C equivalents
atoi() and atol() by checking for overflow and not allowing whitespace.
For conversion of strings _to signed types, the grammar recognized is:
$(PRE $(I Integer):
$(I Sign UnsignedInteger)
$(I UnsignedInteger)
$(I Sign):
$(B +)
$(B -))
For conversion _to unsigned types, the grammar recognized is:
$(PRE $(I UnsignedInteger):
$(I DecimalDigit)
$(I DecimalDigit) $(I UnsignedInteger))
to;
(alias) object.string = stringstring (local variable) string ss = (parameter) int ee < 0 ? "⁻" : "";
foreach ((parameter) immutable(char) chch; ((parameter) int ee < 0 ? -(parameter) int ee : (parameter) int ee).string std.conv.to!string.to!int(int __param_0) pure nothrow @safeThe to template converts a value from one type to another.
The source type is deduced and the target type must be specified, for example the
expression to`!int(42.0)` converts the number 42 from
`double` to `int`. The conversion is "safe", i.e.,
it checks for overflow; to!int(4.2e10) would throw the
ConvOverflowException exception. Overflow checks are only
inserted when necessary, e.g., ``to!double(42) does not do
any checking because any int fits in a double.
Conversions from string to numeric types differ from the C equivalents
atoi() and atol() by checking for overflow and not allowing whitespace.
For conversion of strings to signed types, the grammar recognized is:
Integer:
Sign UnsignedInteger
UnsignedInteger
Sign:
+
-
For conversion to unsigned types, the grammar recognized is:
UnsignedInteger:
DecimalDigit
DecimalDigit UnsignedInteger
Examples
Converting a value to its own type (useful mostly for generic code)
simply returns its argument.
int a = 42;
int b = to!int(a);
double c = to!double(3.14); // c is double with value 3.14
Converting among numeric types is a safe way to cast them around.
Conversions from floating-point types to integral types allow loss of
precision (the fractional part of a floating-point number). The
conversion is truncating towards zero, the same way a cast would
truncate. (To round a floating point value when casting to an
integral, use roundTo.)
import std.exception : assertThrown;
int a = 420;
assert(to!long(a) == a);
assertThrown!ConvOverflowException(to!byte(a));
assert(to!int(4.2e6) == 4200000);
assertThrown!ConvOverflowException(to!uint(-3.14));
assert(to!uint(3.14) == 3);
assert(to!uint(3.99) == 3);
assert(to!int(-3.99) == -3);
When converting strings to numeric types, note that D hexadecimal and binary
literals are not handled. Neither the prefixes that indicate the base, nor the
horizontal bar used to separate groups of digits are recognized. This also
applies to the suffixes that indicate the type.
To work around this, you can specify a radix for conversions involving numbers.
auto str = to!string(42, 16);
assert(str == "2A");
auto i = to!int(str, 16);
assert(i == 42);
Conversions from integral types to floating-point types always
succeed, but might lose accuracy. The largest integers with a
predecessor representable in floating-point format are 2^24-1 for
float, 2^53-1 for double, and 2^64-1 for real (when
real is 80-bit, e.g. on Intel machines).
// 2^24 - 1, largest proper integer representable as float
int a = 16_777_215;
assert(to!int(to!float(a)) == a);
assert(to!int(to!float(-a)) == -a);
Conversion from string types to char types enforces the input
to consist of a single code point, and said code point must
fit in the target type. Otherwise, ConvException is thrown.
import std.exception : assertThrown;
assert(to!char("a") == 'a');
assertThrown(to!char("ñ")); // 'ñ' does not fit into a char
assert(to!wchar("ñ") == 'ñ');
assertThrown(to!wchar("😃")); // '😃' does not fit into a wchar
assert(to!dchar("😃") == '😃');
// Using wstring or dstring as source type does not affect the result
assert(to!char("a"w) == 'a');
assert(to!char("a"d) == 'a');
// Two code points cannot be converted to a single one
assertThrown(to!char("ab"));
Converting an array to another array type works by converting each
element in turn. Associative arrays can be converted to associative
arrays as long as keys and values can in turn be converted.
import std.string : split;
int[] a = [1, 2, 3];
auto b = to!(float[])(a);
assert(b == [1.0f, 2, 3]);
string str = "1 2 3 4 5 6";
auto numbers = to!(double[])(split(str));
assert(numbers == [1.0, 2, 3, 4, 5, 6]);
int[string] c;
c["a"] = 1;
c["b"] = 2;
auto d = to!(double[wstring])(c);
assert(d["a"w] == 1 && d["b"w] == 2);
Conversions operate transitively, meaning that they work on arrays and
associative arrays of any complexity.
This conversion works because to`!short` applies to an `int`, to!wstring
applies to a string, to`!string` applies to a `double`, and
to!(double[]) applies to an int[]. The conversion might throw an
exception because ``to!short might fail the range check.
int[string][double[int[]]] a;
auto b = to!(short[wstring][string[double[]]])(a);
Object-to-object conversions by dynamic casting throw exception when
the source is non-null and the target is null.
import std.exception : assertThrown;
// Testing object conversions
class A {}
class B : A {}
class C : A {}
A a1 = new A, a2 = new B, a3 = new C;
assert(to!B(a2) is a2);
assert(to!C(a3) is a3);
assertThrown!ConvException(to!B(a3));
Stringize conversion from all types is supported.
String to string conversion works for any two string types having
(char, wchar, dchar) character widths and any
combination of qualifiers (mutable, const, or immutable).
Converts array (other than strings) to string.
Each element is converted by calling ``to!T.
Associative array to string conversion.
Each element is converted by calling ``to!T.
Object to string conversion calls toString against the object or
returns "null" if the object is null.
Struct to string conversion calls toString against the struct if
it is defined.
For structs that do not define toString, the conversion to string
produces the list of fields.
Enumerated types are converted to strings as their symbolic names.
Boolean values are converted to "true" or "false".
char, wchar, dchar to a string type.
Unsigned or signed integers to strings.
: Convert integral value to string in radix radix.
radix must be a value from 2 to 36.
value is treated as a signed value only if radix is 10.
The characters A through Z are used to represent values 10 through 36
and their case is determined by the letterCase parameter.
All floating point types to all string types.
Pointer to string conversions convert the pointer to a size_t value.
If pointer is char*, treat it as C-style strings.
In that case, this function is @system.
See formatValue on how toString should be defined.
// Conversion representing dynamic/static array with string
long[] a = [ 1, 3, 5 ];
assert(to!string(a) == "[1, 3, 5]");
// Conversion representing associative array with string
int[string] associativeArray = ["0":1, "1":2];
assert(to!string(associativeArray) == `["0":1, "1":2]` ||
to!string(associativeArray) == `["1":2, "0":1]`);
// char* to string conversion
assert(to!string(cast(char*) null) == "");
assert(to!string("foo\0".ptr) == "foo");
// Conversion reinterpreting void array to string
auto w = "abcx"w;
const(void)[] b = w;
assert(b.length == 8);
auto c = to!(wchar[])(b);
assert(c == "abcx");
Strings can be converted to enum types. The enum member with the same name as the
input string is returned. The comparison is case-sensitive.
A ConvException is thrown if the enum does not have the specified member.
import std.exception : assertThrown;
enum E { a, b, c }
assert(to!E("a") == E.a);
assert(to!E("b") == E.b);
assertThrown!ConvException(to!E("A"));
to!(alias) object.string = stringstring)
(local variable) string ss ~= (immutable global) immutable(string[]) uom_quantity_diagnostics.unitString.supDigitsupDigit[(local variable) immutable(char) chch - '0'];
return (local variable) string ss;
}
(alias) object.string = stringstring (local variable) string resultresult;
void void uom_quantity_diagnostics.unitString.put(in string symbol, in int exp) pure nothrow @safeput(in (alias) object.string = stringstring (parameter) const(string) symbolsymbol, in int (parameter) const(int) expexp)
{
if ((parameter) const(int) expexp == 0)
return;
if ((local variable) string resultresult.(field) ulong string.lengthlength > 0)
(local variable) string resultresult ~= "·";
(local variable) string resultresult ~= (parameter) const(string) symbolsymbol;
if ((parameter) const(int) expexp != 1)
(local variable) string resultresult ~= string uom_quantity_diagnostics.unitString.superscript(int e) pure nothrow @safesuperscript((parameter) const(int) expexp);
}
void uom_quantity_diagnostics.unitString.put(in string symbol, in int exp) pure nothrow @safeput("kg", (parameter) const(uom_quantity_diagnostics.Dim) dd.(field) int uom_quantity_diagnostics.Dim.massmass);
void uom_quantity_diagnostics.unitString.put(in string symbol, in int exp) pure nothrow @safeput("m", (parameter) const(uom_quantity_diagnostics.Dim) dd.(field) int uom_quantity_diagnostics.Dim.lengthlength);
void uom_quantity_diagnostics.unitString.put(in string symbol, in int exp) pure nothrow @safeput("s", (parameter) const(uom_quantity_diagnostics.Dim) dd.(field) int uom_quantity_diagnostics.Dim.timetime);
void uom_quantity_diagnostics.unitString.put(in string symbol, in int exp) pure nothrow @safeput("sr", (parameter) const(uom_quantity_diagnostics.Dim) dd.(field) int uom_quantity_diagnostics.Dim.solidAnglesolidAngle);
return (local variable) string resultresult.(field) ulong string.lengthlength > 0 ? (local variable) string resultresult : "(dimensionless)";
}
/// A graded quantity: one bare `double` tagged with its dimension, plus two
/// compile-time labels used only by the diagnostic machinery — a domain `kind`
/// name (`"Radiance"`) and a preferred display `unit` (`"W·m⁻²·sr⁻¹"`). When a
/// label is empty (an anonymous product of a `*`/`/`), it falls back to the
/// CTFE-derived base-SI form from `unitString`.
struct (struct) uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr")A graded quantity: one bare double tagged with its dimension, plus two
compile-time labels used only by the diagnostic machinery — a domain kind
name ("Radiance") and a preferred display unit ("W·m⁻²·sr⁻¹"). When a
label is empty (an anonymous product of a *//), it falls back to the
CTFE-derived base-SI form from unitString.
Quantity(Dim dim, string kind = "", string unit = "")
{
double (field) double uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr").valuevalue;
/// The dimension exponent vector (read by `checkAddable`).
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr").dimension = Dim(0, 0, 0, 1)The dimension exponent vector (read by checkAddable).
dimension = (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.dim = Dim(0, 0, 0, 1)dim;
/// Domain kind name, or the derived base-unit form for anonymous products.
enum (alias) object.string = stringstring (constant) string uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr").kindName = "Solid angle"Domain kind name, or the derived base-unit form for anonymous products.
kindName = (constant) string uom_quantity_diagnostics.kind = "Solid angle"kind.(constant) ulong "Solid angle".length = 11LUlength ? (constant) string uom_quantity_diagnostics.kind = "Solid angle"kind : "quantity";
/// Preferred display unit, or the CTFE-derived base-SI form.
enum (alias) object.string = stringstring (constant) string uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr").unitLabel = "sr"Preferred display unit, or the CTFE-derived base-SI form.
unitLabel = (constant) string uom_quantity_diagnostics.unit = "sr"unit.(constant) ulong "sr".length = 2LUlength ? (constant) string uom_quantity_diagnostics.unit = "sr"unit : string uom_quantity_diagnostics.unitString(in uom_quantity_diagnostics.Dim d) pure @safeCTFE dimension pretty-printer: renders an exponent vector as SI base symbols
joined by middle dots with Unicode superscripts, e.g.
Dim(mass: 1, time: -3, solidAngle: -1) → "kg·s⁻³·sr⁻¹". The identity
renders as "(dimensionless)". GC-allocating, but only ever evaluated at
compile time — this is the custom toString on the dimension value that
lets a diagnostic speak base-SI instead of leaking a struct literal.
unitString((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.dim = Dim(0, 0, 0, 1)dim);
/// `+`/`-` within one grade: both operands share the exact type.
(struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")A graded quantity: one bare double tagged with its dimension, plus two
compile-time labels used only by the diagnostic machinery — a domain kind
name ("Radiance") and a preferred display unit ("W·m⁻²·sr⁻¹"). When a
label is empty (an anonymous product of a *//), it falls back to the
CTFE-derived base-SI form from unitString.
Quantity pure nothrow @nogc @safe Quantity opBinary(string op)(in Quantity rhs) const+/- within one grade: both operands share the exact type.
opBinary(string op)(in (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")A graded quantity: one bare double tagged with its dimension, plus two
compile-time labels used only by the diagnostic machinery — a domain kind
name ("Radiance") and a preferred display unit ("W·m⁻²·sr⁻¹"). When a
label is empty (an anonymous product of a *//), it falls back to the
CTFE-derived base-SI form from unitString.
Quantity (parameter) Quantity rhsrhs) const @safe pure nothrow @nogc
if (op == "+" || op == "-")
=> (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Quantity(mixin("value " ~ op ~ " rhs.value"));
/// `+`/`-` across grades is the *diagnostic* path: instantiating
/// `checkAddable` on a dimension clash fires the engineered domain-language
/// `static assert`, so `radiance + irradiance` fails to compile with prose.
auto auto opBinary(string op, Dim rd, string rk, string ru)(in Quantity!(rd, rk, ru) rhs) const+/- across grades is the diagnostic path: instantiating
checkAddable on a dimension clash fires the engineered domain-language
static assert, so radiance + irradiance fails to compile with prose.
opBinary(string op, Dim rd, string rk, string ru)(in Quantity!((unresolved type) rdrd, rk, ru) (parameter) Quantity!(rd, rk, ru) rhsrhs) const
if ((op == "+" || op == "-") && rd != dim)
{
enum (constant) _ = checkAddable!(typeof(this), Quantity!(rd, rk, ru))_ = (template instance) checkAddable!(typeof(this), Quantity!(rd, rk, ru))checkAddable!(typeof(this), Quantity!((unresolved type) rdrd, rk, ru)); // emits the domain assert
return this; // unreachable — the static assert above aborts this instantiation
}
/// `*`/`/` are total: dimensions combine, and the result is an anonymous
/// product whose unit label comes from the CTFE `unitString` printer.
auto pure nothrow @nogc @safe auto opBinary(string op, Dim rd, string rk, string ru)(in Quantity!(rd, rk, ru) rhs) const*// are total: dimensions combine, and the result is an anonymous
product whose unit label comes from the CTFE unitString printer.
opBinary(string op, Dim rd, string rk, string ru)(in (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W").rd = Dim(0, 2, 0, 0)Quantity!((unresolved type) rdrd, rk, ru) (parameter) Quantity!(rd, rk, ru) rhsrhs) const
@safe pure nothrow @nogc
if (op == "*" || op == "/")
{
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) Dim rdim = combine(dim, rd, op == "*" ? 1 : -1)rdim = uom_quantity_diagnostics.Dim uom_quantity_diagnostics.combine(in uom_quantity_diagnostics.Dim a, in uom_quantity_diagnostics.Dim b, in int sign) pure nothrow @nogc @safeThe group operation, component-wise: sign` = +1` for multiplication,
sign = -1 for division (the group inverse).
combine((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.dim = Dim(1, 0, -3, 0)dim, (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W").rd = Dim(0, 2, 0, 0)rd, (constant) string uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W").op = "/"op == "*" ? 1 : -1);
return (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "").opBinary!("/", Dim(0, 0, 0, 1), "Solid angle", "sr").rdim = Dim(1, 0, -3, -1)Quantity!(constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "").opBinary!("/", Dim(0, 0, 0, 1), "Solid angle", "sr").rdim = Dim(1, 0, -3, -1)rdim(mixin("value " ~ op ~ " rhs.value"));
}
/// Scale by a plain dimensionless scalar, keeping the dimension and labels.
Quantity pure nothrow @nogc @safe Quantity opBinary(string op)(in double s) constScale by a plain dimensionless scalar, keeping the dimension and labels.
opBinary(string op)(in double (parameter) double ss) const @safe pure nothrow @nogc
if (op == "*" || op == "/")
=> Quantity(mixin("value " ~ op ~ " s"));
/// Render as `value unitLabel` through an `appender` sink (kept `@safe`).
(alias) object.string = stringstring string uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr").toString() const pure @safeRender as value unitLabel through an appender sink (kept @safe).
toString() const @safe
{
import (package) stdstd.(module) std.arrayFunctions and types that manipulate built-in arrays and associative arrays.
This module provides all kinds of functions to create, manipulate or convert arrays:
Function Name Description
| array |
Returns a copy of the input in a newly allocated dynamic array.
|
| appender |
Returns a new Appender or RefAppender initialized with a given array.
|
| assocArray |
Returns a newly allocated associative array from a range/ranges of keys and values.
|
| byPair |
Construct a range iterating over an associative array by key/value tuples.
|
| insertInPlace |
Inserts into an existing array at a given position.
|
| join |
Concatenates a range of ranges into one array.
|
| minimallyInitializedArray |
Returns a new array of type T.
|
| replace |
Returns a new array with all occurrences of a certain subrange replaced.
|
| replaceFirst |
Returns a new array with the first occurrence of a certain subrange replaced.
|
| replaceInPlace |
Replaces all occurrences of a certain subrange and puts the result into a given array.
|
| replaceInto |
Replaces all occurrences of a certain subrange and puts the result into an output range.
|
| replaceLast |
Returns a new array with the last occurrence of a certain subrange replaced.
|
| replaceSlice |
Returns a new array with a given slice replaced.
|
| replicate |
Creates a new array out of several copies of an input array or range.
|
| sameHead |
Checks if the initial segments of two arrays refer to the same
place in memory.
|
| sameTail |
Checks if the final segments of two arrays refer to the same place
in memory.
|
| split |
Eagerly split a range or string into an array.
|
| staticArray |
Creates a new static array from given data.
|
| uninitializedArray |
Returns a new array of type T without initializing its elements.
|
Source
std/array.d
array : (alias template) appender = std.array.appender(A)() if (isDynamicArray!A)Convenience function that returns an $(LREF Appender) instance,
optionally initialized with array.
appender;
import (package) stdstd.(module) std.formatThis package provides string formatting functionality using
printf style format strings.
Submodule Function Name Description package format Converts its arguments according to a format string into a string.
| package |
sformat |
Converts its arguments according to a format string into a buffer. |
| package |
FormatException |
Signals a problem while formatting. |
| write |
formattedWrite |
Converts its arguments according to a format string and writes
the result to an output range. |
| write |
formatValue |
Formats a value of any type according to a format specifier and
writes the result to an output range. |
| read |
formattedRead |
Reads an input range according to a format string and stores the read
values into its arguments. |
| read |
unformatValue |
Reads a value from the given input range and converts it according to
a format specifier. |
| spec |
FormatSpec |
A general handler for format strings. |
| spec |
singleSpec |
Helper function that returns a FormatSpec for a single format specifier. |
Limitation
This package does not support localization, but
adheres to the rounding mode of the floating point unit, if
available.
Format Strings
The functions contained in this package use format strings. A
format string describes the layout of another string for reading or
writing purposes. A format string is composed of normal text
interspersed with format specifiers. A format specifier starts
with a percentage sign '%', optionally followed by one or more
parameters and ends with a format indicator. A format
indicator may be a simple format character or a compound
indicator.
Format strings are composed according to the following grammar:
FormatString:
FormatStringItem FormatString
FormatStringItem:
Character
FormatSpecifier
FormatSpecifier:
'%' Parameters FormatIndicator
FormatIndicator:
FormatCharacter
CompoundIndicator
FormatCharacter:
see remark below
CompoundIndicator:
'(' FormatString '%)'
'(' FormatString '%|' Delimiter '%)'
Delimiter
empty
Character Delimiter
Parameters:
Position Flags Width Precision Separator
Position:
empty
Integer '$'**
*Integer* **':'** *Integer* **'$'
Integer ':' '$'**
*Flags*:
*empty*
*Flag* *Flags*
*Flag*:
**'-'**|**'+'**|**' '**|**'0'**|**'#'**|**'='**
*Width*:
*OptionalPositionalInteger*
*Precision*:
*empty*
**'.'** *OptionalPositionalInteger*
*Separator*:
*empty*
**','** *OptionalInteger*
**','** *OptionalInteger* **'?'**
*OptionalInteger*:
*empty*
*Integer*
**'*'**
*OptionalPositionalInteger*:
*OptionalInteger*
**'*'** *Integer* **'$'
Character
'%%'
AnyCharacterExceptPercent
Integer:
NonZeroDigit Digits
Digits:
empty
Digit Digits
NonZeroDigit:
'1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'
Digit:
'0'|'1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'
Note
FormatCharacter is unspecified. It can be any character
that has no other purpose in this grammar, but it is
recommended to assign (lower- and uppercase) letters.
Note
The Parameters of a CompoundIndicator are currently
limited to a '-' flag.
Format Indicator
The format indicator can either be a single character or an
expression surrounded by '%(' and '%)'. It specifies the
basic manner in which a value will be formatted and is the minimum
requirement to format a value.
The following characters can be used as format characters:
FormatCharacter Semantics 's' To be formatted in a human readable format. Can be used with all types. 'c' To be formatted as a character. 'd' To be formatted as a signed decimal integer. 'u' To be formatted as a decimal image of the underlying bit representation. 'b' To be formatted as a binary image of the underlying bit representation. 'o' To be formatted as an octal image of the underlying bit representation. 'x' / 'X' To be formatted as a hexadecimal image of the underlying bit representation. 'e' / 'E' To be formatted as a real number in decimal scientific notation. 'f' / 'F' To be formatted as a real number in decimal natural notation. 'g' / 'G' To be formatted as a real number in decimal short notation. Depending on the number, a scientific notation or a natural notation is used. 'a' / 'A' To be formatted as a real number in hexadecimal scientific notation. 'r' To be formatted as raw bytes. The output may not be printable and depends on endianness.
The compound indicator can be used to describe compound types
like arrays or structs in more detail. A compound type is enclosed
within '%(' and '%)'. The enclosed sub-format string is
applied to individual elements. The trailing portion of the
sub-format string following the specifier for the element is
interpreted as the delimiter, and is therefore omitted following the
last element. The '%|' specifier may be used to explicitly
indicate the start of the delimiter, so that the preceding portion of
the string will be included following the last element.
The format string inside of the compound indicator should
contain exactly one format specifier (two in case of associative
arrays), which specifies the formatting mode of the elements of the
compound type. This format specifier can be a compound
indicator itself.
Note
Inside a compound indicator, strings and characters are
escaped automatically. To avoid this behavior, use "%-("
instead of "%(".
Flags
There are several flags that affect the outcome of the formatting.
Flag Semantics '-' When the formatted result is shorter than the value given by the width parameter, the output is left justified. Without the '-' flag, the output remains right justified.
There are two exceptions where the '-' flag has a
different meaning: (1) with 'r' it denotes to use little
endian and (2) in case of a compound indicator it means that
no special handling of the members is applied. |
| '=' |
When the formatted result is shorter than the value
given by the width parameter, the output is centered.
If the central position is not possible it is moved slightly
to the right. In this case, if '-' flag is present in
addition to the '=' flag, it is moved slightly to the left. |
| '+' / *' '* |
Applies to numerical values. By default, positive numbers are not
formatted to include the + sign. With one of these two flags present,
positive numbers are preceded by a plus sign or a space.
When both flags are present, a plus sign is used.
In case of 'r', a big endian format is used. |
| '0' |
Is applied to numerical values that are printed right justified.
If the zero flag is present, the space left to the number is
filled with zeros instead of spaces. |
| '#' |
Denotes that an alternative output must be used. This depends on the type
to be formatted and the format character used. See the
sections below for more information. |
Width, Precision and Separator
The width parameter specifies the minimum width of the result.
The meaning of precision depends on the format indicator. For
integers it denotes the minimum number of digits printed, for
real numbers it denotes the number of fractional digits and for
strings and compound types it denotes the maximum number of elements
that are included in the output.
A separator is used for formatting numbers. If it is specified,
the output is divided into chunks of three digits, separated by a ','. The number of digits in a chunk can be given explicitly by
providing a number or a ''* after the ','.
In all three cases the number of digits can be replaced by a ''*. In this scenario, the next argument is used as the number of
digits. If the argument is a negative number, the precision and
separator parameters are considered unspecified. For width,
the absolute value is used and the '-' flag is set.
The separator can also be followed by a '?'. In that case,
an additional argument is used to specify the symbol that should be
used to separate the chunks.
Position
By default, the arguments are processed in the provided order. With
the position parameter it is possible to address arguments
directly. It is also possible to denote a series of arguments with
two numbers separated by ':', that are all processed in the same
way. The second number can be omitted. In that case the series ends
with the last argument.
It's also possible to use positional arguments for width, precision and separator by adding a number and a '$' after the ''*.
Types
This section describes the result of combining types with format
characters. It is organized in 2 subsections: a list of general
information regarding the formatting of types in the presence of
format characters and a table that contains details for every
available combination of type and format character.
When formatting types, the following rules apply:
If the format character is upper case, the resulting string will
be formatted using upper case letters.
The default precision for floating point numbers is 6 digits.
Rounding of floating point numbers adheres to the rounding mode
of the floating point unit, if available.
The floating point values NaN and Infinity are formatted as
nan and inf, possibly preceded by '+' or '-' sign.
Formatting reals is only supported for 64 bit reals and 80 bit reals.
All other reals are cast to double before they are formatted. This will
cause the result to be inf for very large numbers.
Characters and strings formatted with the 's' format character
inside of compound types are surrounded by single and double quotes
and unprintable characters are escaped. To avoid this, a '-'
flag can be specified for the compound specifier
(e.g. "%-(%s%)" instead of "%(%s%)" ).
Structs, unions, classes and interfaces are formatted by calling a
toString method if available.
See module std.format.write for more
details.
Only part of these combinations can be used for reading. See
module std.format.read for more
detailed information.
This table contains descriptions for every possible combination of
type and format character:
<th scope="col" width="20%">Type</th> <th scope="col" width="20%">Format Character</th> Formatted as... <td rowspan="1">null</td> 's' null
|<td rowspan="3">bool</td> 's' |
false or true |
| 'b', 'd', 'o', 'u', 'x', 'X' |
As the integrals 0 or 1 with the same format character.
Please note, that 'o' and 'x' with '#' flag
might produce unexpected results due to special handling of
the value 0. |
| 'r' |
\0 or \1 |
|<td rowspan="4">Integral</td> 's', 'd' |
A signed decimal number. The '#' flag is ignored. |
| 'b', 'o', 'u', 'x', 'X' |
An unsigned binary, decimal, octal or hexadecimal number.
In case of 'o' and 'x', the '#' flag
denotes that the number must be preceded by 0 and 0x, with
the exception of the value 0, where this does not apply. For
'b' and 'u' the '#' flag has no effect. |
| 'e', 'E', 'f', 'F', 'g', 'G', 'a', 'A' |
As a floating point value with the same specifier.
Default precision is large enough to add all digits
of the integral value.
In case of 'a' and 'A', the integral digit can be
any hexadecimal digit.
|
| 'r' |
Characters taken directly from the binary representation. |
|<td rowspan="5">Floating Point</td> 'e', 'E' |
Scientific notation: Exactly one integral digit followed by a dot
and fractional digits, followed by the exponent.
The exponent is formatted as 'e' followed by
a '+' or '-' sign, followed by at least
two digits.
When there are no fractional digits and the '#' flag
is not present, the dot is omitted. |
| 'f', 'F' |
Natural notation: Integral digits followed by a dot and
fractional digits.
When there are no fractional digits and the '#' flag
is not present, the dot is omitted.
Please note: the difference between 'f' and 'F'
is only visible for NaN and Infinity. |
| 's', 'g', 'G' |
Short notation: If the absolute value is larger than 10 ^^ precision
or smaller than 0.0001, the scientific notation is used.
If not, the natural notation is applied.
In both cases precision denotes the count of all digits, including
the integral digits. Trailing zeros (including a trailing dot) are removed.
If '#' flag is present, trailing zeros are not removed. |
| 'a', 'A' |
Hexadecimal scientific notation: 0x followed by 1
(or 0 in case of value zero or denormalized number)
followed by a dot, fractional digits in hexadecimal
notation and an exponent. The exponent is build by p,
followed by a sign and the exponent in decimal notation.
When there are no fractional digits and the '#' flag
is not present, the dot is omitted. |
| 'r' |
Characters taken directly from the binary representation. |
|<td rowspan="3">Character</td> 's', 'c' |
As the character.
Inside of a compound indicator 's' is treated differently: The
character is surrounded by single quotes and non printable
characters are escaped. This can be avoided by preceding
the compound indicator with a '-' flag
(e.g. "%-(%s%)"). |
| 'b', 'd', 'o', 'u', 'x', 'X' |
As the integral that represents the character. |
| 'r' |
Characters taken directly from the binary representation. |
|<td rowspan="3">String</td> 's' |
The sequence of characters that form the string.
Inside of a compound indicator the string is surrounded by double quotes
and non printable characters are escaped. This can be avoided
by preceding the compound indicator with a '-' flag
(e.g. "%-(%s%)"). |
| 'r' |
The sequence of characters, each formatted with 'r'. |
| compound |
As an array of characters. |
|<td rowspan="3">Array</td> 's' |
When the elements are characters, the array is formatted as
a string. In all other cases the array is surrounded by square brackets
and the elements are separated by a comma and a space. If the elements
are strings, they are surrounded by double quotes and non
printable characters are escaped. |
| 'r' |
The sequence of the elements, each formatted with 'r'. |
| compound |
The sequence of the elements, each formatted according to the specifications
given inside of the compound specifier. |
|<td rowspan="2">Associative Array</td> 's' |
As a sequence of the elements in unpredictable order. The output is
surrounded by square brackets. The elements are separated by a
comma and a space. The elements are formatted as key:value. |
| compound |
As a sequence of the elements in unpredictable order. Each element
is formatted according to the specifications given inside of the
compound specifier. The first specifier is used for formatting
the key and the second specifier is used for formatting the value.
The order can be changed with positional arguments. For example
"%(%2$s (%1$s), %)" will write the value, followed by the key in
parenthesis. |
|<td rowspan="2">Enum</td> 's' |
The name of the value. If the name is not available, the base value
is used, preceeded by a cast. |
| All, but 's' |
Enums can be formatted with all format characters that can be used
with the base value. In that case they are formatted like the base value. |
|<td rowspan="3">Input Range</td> 's' |
When the elements of the range are characters, they are written like a string.
In all other cases, the elements are enclosed by square brackets and separated
by a comma and a space. |
| 'r' |
The sequence of the elements, each formatted with 'r'. |
| compound |
The sequence of the elements, each formatted according to the specifications
given inside of the compound specifier. |
|<td rowspan="1">Struct</td> 's' |
When the struct has neither an applicable toString
nor is an input range, it is formatted as follows:
StructType(field1, field2, ...). |
|<td rowspan="1">Class</td> 's' |
When the class has neither an applicable toString
nor is an input range, it is formatted as the
fully qualified name of the class. |
|<td rowspan="1">Union</td> 's' |
When the union has neither an applicable toString
nor is an input range, it is formatted as its base name. |
|<td rowspan="2">Pointer</td> 's' |
A null pointer is formatted as 'null'. All other pointers are
formatted as hexadecimal numbers with the format character 'X'. |
| 'x', 'X' |
Formatted as a hexadecimal number. |
|<td rowspan="3">SIMD vector</td> 's' |
The array is surrounded by square brackets
and the elements are separated by a comma and a space. |
| 'r' |
The sequence of the elements, each formatted with 'r'. |
| compound |
The sequence of the elements, each formatted according to the specifications
given inside of the compound specifier. |
|<td rowspan="1">Delegate</td> 's', 'r', compound |
As the .stringof of this delegate treated as a string.
Please note: The implementation is currently buggy
and its use is discouraged. |
Source
std/format/package.d
Examples
Simple use:
// Easiest way is to use `%s` everywhere:
assert(format("I got %s %s for %s euros.", 30, "eggs", 5.27) == "I got 30 eggs for 5.27 euros.");
// Other format characters provide more control:
assert(format("I got %b %(%X%) for %f euros.", 30, "eggs", 5.27) == "I got 11110 65676773 for 5.270000 euros.");
Compound specifiers allow formatting arrays and other compound types:
/*
The trailing end of the sub-format string following the specifier for
each item is interpreted as the array delimiter, and is therefore
omitted following the last array item:
*/
assert(format("My items are %(%s %).", [1,2,3]) == "My items are 1 2 3.");
assert(format("My items are %(%s, %).", [1,2,3]) == "My items are 1, 2, 3.");
/*
The "%|" delimiter specifier may be used to indicate where the
delimiter begins, so that the portion of the format string prior to
it will be retained in the last array element:
*/
assert(format("My items are %(-%s-%|, %).", [1,2,3]) == "My items are -1-, -2-, -3-.");
/*
These compound format specifiers may be nested in the case of a
nested array argument:
*/
auto mat = [[1, 2, 3],
[4, 5, 6],
[7, 8, 9]];
assert(format("%(%(%d %) - %)", mat), "1 2 3 - 4 5 6 - 7 8 9");
assert(format("[%(%(%d %) - %)]", mat), "[1 2 3 - 4 5 6 - 7 8 9]");
assert(format("[%([%(%d %)]%| - %)]", mat), "[1 2 3] - [4 5 6] - [7 8 9]");
/*
Strings and characters are escaped automatically inside compound
format specifiers. To avoid this behavior, use "%-(" instead of "%(":
*/
assert(format("My friends are %s.", ["John", "Nancy"]) == `My friends are ["John", "Nancy"].`);
assert(format("My friends are %(%s, %).", ["John", "Nancy"]) == `My friends are "John", "Nancy".`);
assert(format("My friends are %-(%s, %).", ["John", "Nancy"]) == `My friends are John, Nancy.`);
Using parameters:
// Flags can be used to influence to outcome:
assert(format("%g != %+#g", 3.14, 3.14) == "3.14 != +3.14000");
// Width and precision help to arrange the formatted result:
assert(format(">%10.2f<", 1234.56789) == "> 1234.57<");
// Numbers can be grouped:
assert(format("%,4d", int.max) == "21,4748,3647");
// It's possible to specify the position of an argument:
assert(format("%3$s %1$s", 3, 17, 5) == "5 3");
Providing parameters as arguments:
// Width as argument
assert(format(">%*s<", 10, "abc") == "> abc<");
// Precision as argument
assert(format(">%.*f<", 5, 123.2) == ">123.20000<");
// Grouping as argument
assert(format("%,*d", 1, int.max) == "2,1,4,7,4,8,3,6,4,7");
// Grouping separator as argument
assert(format("%,3?d", '_', int.max) == "2_147_483_647");
// All at once
assert(format("%*.*,*?d", 20, 15, 6, '/', int.max) == " 000/002147/483647");
format : (alias template) formattedWrite = std.format.write.formattedWrite(Writer, Char, Args...)(auto ref Writer w, scope const Char[] fmt, Args args)Converts its arguments according to a format string and writes
the result to an output range.
The second version of formattedWrite takes the format string as a
template argument. In this case, it is checked for consistency at
compile-time.
Params:
w = an $(REF_ALTTEXT output range, isOutputRange, std, range, primitives),
where the formatted result is written to
fmt = a $(MREF_ALTTEXT format string, std,format)
args = a variadic list of arguments to be formatted
Writer = the type of the writer w
Char = character type of fmt
Args = a variadic list of types of the arguments
Returns:
The index of the last argument that was formatted. If no positional
arguments are used, this is the number of arguments that where formatted.
Throws:
A $(REF_ALTTEXT FormatException, FormatException, std, format)
if formatting did not succeed.
Note:
In theory this function should be @nogc. But with the current
implementation there are some cases where allocations occur.
See $(REF_ALTTEXT $(D sformat), sformat, std, format) for more details.
formattedWrite;
auto (local variable) std.array.Appender!string sinksink = std.array.Appender!string std.array.appender!string() pure nothrow @safeConvenience function that returns an Appender instance,
optionally initialized with array.
appender!(alias) object.string = stringstring();
uint std.format.write.formattedWrite!(std.array.Appender!string, char, const(double), string)(ref std.array.Appender!string w, scope const(char[]) fmt, const(double) __param_2, string __param_3) pure @safeConverts its arguments according to a format string and writes
the result to an output range.
The second version of formattedWrite takes the format string as a
template argument. In this case, it is checked for consistency at
compile-time.
Note
In theory this function should be @nogc. But with the current
implementation there are some cases where allocations occur.
See sformat for more details.
Examples
import std.array : appender;
auto writer1 = appender!string();
formattedWrite(writer1, "%s is the ultimate %s.", 42, "answer");
assert(writer1[] == "42 is the ultimate answer.");
auto writer2 = appender!string();
formattedWrite(writer2, "Increase: %7.2f %%", 17.4285);
assert(writer2[] == "Increase: 17.43 %");
formattedWrite((local variable) std.array.Appender!string sinksink, "%.6g %s", (field) double uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr").valuevalue, (constant) string uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr").unitLabel = "sr"Preferred display unit, or the CTFE-derived base-SI form.
unitLabel);
return (local variable) std.array.Appender!string sinksink[];
}
}
/// The engineered domain-language mismatch sentence for an add of `A` to `B`.
/// Factored out of `checkAddable` so a `pragma(msg, …)` can *show* the exact
/// message text at compile time without failing the build.
enum (alias) object.string = stringstring (constant) string uom_quantity_diagnostics.addMismatchMsg!(const(uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")), uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")) = "cannot add Radiance [W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9] to Irradiance [W\xc2\xb7m\xe2\x81\xbb\xc2\xb2] \xe2\x80\x94 dimensions differ"The engineered domain-language mismatch sentence for an add of A to B.
Factored out of checkAddable so a pragma(msg, …) can show the exact
message text at compile time without failing the build.
addMismatchMsg(A, B) =
"cannot add " ~ (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")A.(constant) string uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9").kindName = "Radiance"Domain kind name, or the derived base-unit form for anonymous products.
kindName ~ " [" ~ (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")A.(constant) string uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9").unitLabel = "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9"Preferred display unit, or the CTFE-derived base-SI form.
unitLabel ~ "] to "
~ (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")B.(constant) string uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2").kindName = "Irradiance"Domain kind name, or the derived base-unit form for anonymous products.
kindName ~ " [" ~ (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")B.(constant) string uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2").unitLabel = "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2"Preferred display unit, or the CTFE-derived base-SI form.
unitLabel ~ "] — dimensions differ";
/// The `static assert` gate. Same dimension → `true`; otherwise a hard,
/// passing-by-construction compile error carrying `addMismatchMsg` prose. This
/// is D's analogue of Au's prose `static_assert` and mp-units' `unsatisfied<…>`.
template (template) uom_quantity_diagnostics.checkAddable(A, B)The static assert gate. Same dimension → true; otherwise a hard,
passing-by-construction compile error carrying addMismatchMsg prose. This
is D's analogue of Au's prose static_assert and mp-units' unsatisfied<…>.
checkAddable(A, B)
{
static if ((struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")A.(constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9").dimension = Dim(1, 0, -3, -1)The dimension exponent vector (read by checkAddable).
dimension == (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")B.(constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9").dimension = Dim(1, 0, -3, -1)The dimension exponent vector (read by checkAddable).
dimension)
enum bool (constant) bool uom_quantity_diagnostics.checkAddable!(uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9"), uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")) = trueThe static assert gate. Same dimension → true; otherwise a hard,
passing-by-construction compile error carrying addMismatchMsg prose. This
is D's analogue of Au's prose static_assert and mp-units' unsatisfied<…>.
checkAddable = true;
else
static assert(false, (template instance) addMismatchMsg!(A, B)addMismatchMsg!((unresolved type) AA, (unresolved type) BB));
}
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.lengthDim = Dim(0, 1, 0, 0)lengthDim = (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim(length: 1);
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.areaDim = Dim(0, 2, 0, 0)areaDim = (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim(length: 2);
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.solidAngleDim = Dim(0, 0, 0, 1)solidAngleDim = (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim(solidAngle: 1);
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.powerDim = Dim(1, 2, -3, 0)powerDim = (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim(mass: 1, length: 2, time: -3); // W = kg·m²·s⁻³
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)irradianceDim = (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim(mass: 1, time: -3); // W·m⁻² = kg·s⁻³
enum (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.radianceDim = Dim(1, 0, -3, -1)radianceDim = (struct) uom_quantity_diagnostics.DimA dimension: an exponent vector in the free abelian group ℤ⁴ over the base
dimensions (mass, length, time, solid angle), stored as its unique normal
form. Solid angle is carried as an extra base dimension — the Boost-units
"angle as a dimension" choice — precisely so Radiance and Irradiance,
which are SI-dimensionally identical, become distinguishable types.
Dim(mass: 1, time: -3, solidAngle: -1); // W·m⁻²·sr⁻¹
/// The raytracer's radiometric vocabulary, each with a domain kind name and a
/// preferred derived-unit label — the two ingredients the diagnostic speaks in.
alias (alias) uom_quantity_diagnostics.Length = uom_quantity_diagnostics.Quantity!(Dim(0, 1, 0, 0), "Length", "m")The raytracer's radiometric vocabulary, each with a domain kind name and a
preferred derived-unit label — the two ingredients the diagnostic speaks in.
Length = (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.lengthDim = Dim(0, 1, 0, 0)Quantity!((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.lengthDim = Dim(0, 1, 0, 0)lengthDim, "Length", "m");
alias (alias) uom_quantity_diagnostics.Area = uom_quantity_diagnostics.Quantity!(Dim(0, 2, 0, 0), "Area", "m\xc2\xb2")Area = (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.areaDim = Dim(0, 2, 0, 0)Quantity!((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.areaDim = Dim(0, 2, 0, 0)areaDim, "Area", "m²");
alias (alias) uom_quantity_diagnostics.SolidAngle = uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr")SolidAngle = (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.solidAngleDim = Dim(0, 0, 0, 1)Quantity!((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.solidAngleDim = Dim(0, 0, 0, 1)solidAngleDim, "Solid angle", "sr");
alias (alias) uom_quantity_diagnostics.Power = uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W")Power = (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.powerDim = Dim(1, 2, -3, 0)Quantity!((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.powerDim = Dim(1, 2, -3, 0)powerDim, "Power", "W");
alias (alias) uom_quantity_diagnostics.Irradiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")Irradiance = (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)Quantity!((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)irradianceDim, "Irradiance", "W·m⁻²");
alias (alias) uom_quantity_diagnostics.Radiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance = (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.radianceDim = Dim(1, 0, -3, -1)Quantity!((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.radianceDim = Dim(1, 0, -3, -1)radianceDim, "Radiance", "W·m⁻²·sr⁻¹");
// Compile-time demonstration — prints during the build, never at run time, and
// never fails it. Line 1 is the raw encoding leak (the mangled struct literal a
// naive mismatch would surface); line 2 is the engineered domain sentence.
pragma(msg,
"\n[quantity-diagnostics] raw type encoding leaks the struct literal:\n"
~ " " ~ Radiance.stringof ~ "\n"
~ "[quantity-diagnostics] engineered domain diagnostic (demo — build still succeeds):\n"
~ " " ~ addMismatchMsg!(Radiance, Irradiance) ~ "\n");
@("Quantity.diagnostics.checkAddable-gates-on-dimension")
@safe pure nothrow @nogc
unittest
{
// Same dimension is addable; the gate yields `true`.
static assert((template instance) uom_quantity_diagnostics.checkAddable!(uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9"), uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9"))checkAddable!((alias) uom_quantity_diagnostics.Radiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance, (alias) uom_quantity_diagnostics.Radiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance));
static assert(__traits(compiles, (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance(1) + (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance(2)));
// A dimension clash makes `checkAddable` (and hence `+`) fail to compile.
// These asserts PASS precisely because the operations do not — the intended
// failure is turned into a checked part of the program.
static assert(!__traits(compiles, (template instance) uom_quantity_diagnostics.checkAddable!(uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9"), uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2"))checkAddable!((alias) uom_quantity_diagnostics.Radiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance, (alias) uom_quantity_diagnostics.Irradiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")Irradiance)));
static assert(!__traits(compiles, (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance(1) + (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")Irradiance(2)));
// `*`/`/` are total: power over area is an irradiance-dimensioned product,
// and its label is derived by the CTFE `unitString` printer.
auto (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") ee = (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W")Power(1000.0) / uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W").opBinary!("/", Dim(0, 2, 0, 0), "Area", "m\xc2\xb2")(in uom_quantity_diagnostics.Quantity!(Dim(0, 2, 0, 0), "Area", "m\xc2\xb2") rhs) const pure nothrow @nogc @safe*// are total: dimensions combine, and the result is an anonymous
product whose unit label comes from the CTFE unitString printer.
Area(2.0);
static assert(is(typeof((local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") ee) == (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)Quantity!(constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)irradianceDim));
assert((local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") ee.(field) double uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "").valuevalue == 500.0);
static assert((constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)Quantity!(constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)irradianceDim.(constant) string uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "").unitLabel = "kg\xc2\xb7s\xe2\x81\xbb\xc2\xb3"Preferred display unit, or the CTFE-derived base-SI form.
unitLabel == "kg·s⁻³");
}
void void D main() @safemain() @safe
{
import (package) stdstd.(module) std.stdioCategory Symbols File handles _popen File isFileHandle openNetwork stderr stdin stdout Reading chunks lines readf readfln readln Writing toFile write writef writefln writeln Misc KeepTerminator LockType StdioException
Standard I/O functions that extend core.stdc.stdio. core.stdc.stdio
is publically imported when importing std.stdio.
There are three layers of I/O:
The lowest layer is the operating system layer. The two main schemes are Windows and Posix.
C's stdio.h which unifies the two operating system schemes.
std.stdio, this module, unifies the various stdio.h implementations into
a high level package for D programs.
Source
std/stdio.d
stdio : (alias template) writeln = std.stdio.writeln(T...)(T args)Equivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Params:
args = the items to write to stdout
Throws:
In case of an I/O error, throws an $(LREF StdioException).
Example:
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
---
writeln;
// Two radiometric quantities that differ only by a solid-angle exponent.
auto (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9") radianceradiance = (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance(1200.0);
auto (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2") irradianceirradiance = (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")Irradiance(340.0);
// The mismatch is quarantined: this holds because the add does NOT compile,
// so the program builds and runs while the clash stays rejected.
static assert(!__traits(compiles, (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9") radianceradiance + (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2") irradianceirradiance),
"adding radiance to irradiance must not compile");
static assert(__traits(compiles, (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9") radianceradiance + (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9") radianceradiance)); // ...same grade is fine.
// Total products: splitting incident Power over Area gives an Irradiance
// dimension; per unit Solid angle gives a Radiance dimension. Because these
// are anonymous products, their labels come from the CTFE `unitString`
// printer as base-SI normal forms — the honest derivation behind the
// domain-friendly `W·m⁻²` / `W·m⁻²·sr⁻¹` the named aliases advertise.
auto (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") derivedIrradiancederivedIrradiance = (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W")Power(1000.0) / uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") uom_quantity_diagnostics.Quantity!(Dim(1, 2, -3, 0), "Power", "W").opBinary!("/", Dim(0, 2, 0, 0), "Area", "m\xc2\xb2")(in uom_quantity_diagnostics.Quantity!(Dim(0, 2, 0, 0), "Area", "m\xc2\xb2") rhs) const pure nothrow @nogc @safe*// are total: dimensions combine, and the result is an anonymous
product whose unit label comes from the CTFE unitString printer.
Area(2.0);
auto (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "", "") derivedRadiancederivedRadiance = (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") derivedIrradiancederivedIrradiance / uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "", "") uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "").opBinary!("/", Dim(0, 0, 0, 1), "Solid angle", "sr")(in uom_quantity_diagnostics.Quantity!(Dim(0, 0, 0, 1), "Solid angle", "sr") rhs) const pure nothrow @nogc @safe*// are total: dimensions combine, and the result is an anonymous
product whose unit label comes from the CTFE unitString printer.
SolidAngle(4.0);
static assert(is(typeof((local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") derivedIrradiancederivedIrradiance) == (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)Quantity!(constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.irradianceDim = Dim(1, 0, -3, 0)irradianceDim));
static assert(is(typeof((local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "", "") derivedRadiancederivedRadiance) == (constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.radianceDim = Dim(1, 0, -3, -1)Quantity!(constant) uom_quantity_diagnostics.Dim uom_quantity_diagnostics.radianceDim = Dim(1, 0, -3, -1)radianceDim));
void std.stdio.writeln!string(string __param_0) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln("Named domain quantities (preferred derived-unit labels):");
void std.stdio.writeln!(string, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9"))(string __param_0, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9") __param_1) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln(" radiance = ", (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9") radianceradiance);
void std.stdio.writeln!(string, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2"))(string __param_0, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2") __param_1) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln(" irradiance = ", (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2") irradianceirradiance);
void std.stdio.writeln!()() @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln();
void std.stdio.writeln!string(string __param_0) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln("Anonymous products (CTFE unitString → SI base normal form):");
void std.stdio.writeln!(string, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", ""), string)(string __param_0, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") __param_1, string __param_2) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln(" power / area = ", (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "", "") derivedIrradiancederivedIrradiance, " (domain: Irradiance, W·m⁻²)");
void std.stdio.writeln!(string, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "", ""), string)(string __param_0, uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "", "") __param_1, string __param_2) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln(" … / solid angle = ", (local variable) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "", "") derivedRadiancederivedRadiance, " (domain: Radiance, W·m⁻²·sr⁻¹)");
void std.stdio.writeln!()() @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln();
void std.stdio.writeln!string(string __param_0) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln("The rejected add, spoken in the raytracer's own vocabulary:");
void std.stdio.writeln!(string, string)(string __param_0, string __param_1) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln(" ", (template instance) uom_quantity_diagnostics.addMismatchMsg!(uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9"), uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2"))addMismatchMsg!((alias) uom_quantity_diagnostics.Radiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance, (alias) uom_quantity_diagnostics.Irradiance = uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, 0), "Irradiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2")Irradiance));
void std.stdio.writeln!()() @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln();
void std.stdio.writeln!string(string __param_0) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln("Contrast — the raw encoding a naive mismatch would leak:");
void std.stdio.writeln!(string, string)(string __param_0, string __param_1) @safeEquivalent to write(args, '\n'). Calling writeln without
arguments is valid and just prints a newline to the standard
output.
Example
Reads stdin and writes it to stdout with an argument
counter.
import std.stdio;
void main()
{
string line;
for (size_t count = 0; (line = readln) !is null; count++)
{
writeln("Input ", count, ": ", line);
}
}
writeln(" ", (struct) uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9")Radiance.(constant) string uom_quantity_diagnostics.Quantity!(Dim(1, 0, -3, -1), "Radiance", "W\xc2\xb7m\xe2\x81\xbb\xc2\xb2\xc2\xb7sr\xe2\x81\xbb\xc2\xb9").stringof = "Quantity!(Dim(1, 0, -3, -1), \"Radiance\", \"W\\xc2\\xb7m\\xe2\\x81\\xbb\\xc2\\xb2\\xc2\\xb7sr\\xe2\\x81\\xbb\\xc2\\xb9\")"stringof);
}