function f16
f16(endianness?: Endianness): Coder<number>

Creates a coder for 16-bit floating-point numbers.

This function creates a coder that can encode/decode 16-bit floating-point numbers (half-precision IEEE 754 format). The endianness parameter determines the byte order used.

Examples

Example 1

import { assertEquals } from "@std/assert";
import { f16 } from "@hertzg/binstruct/numeric";

// Create big-endian and little-endian coders
const f16be = f16("be");
const f16le = f16("le");

// Test data
const testValue = 3.14;

// Encode and decode with big-endian
const bufferBE = new Uint8Array(2);
const bytesWrittenBE = f16be.encode(testValue, bufferBE);
const [decodedBE, bytesReadBE] = f16be.decode(bufferBE);

// Use approximate comparison for floating-point precision
assertEquals(Math.abs(decodedBE - testValue) < 0.01, true);
assertEquals(bytesWrittenBE, 2);
assertEquals(bytesReadBE, 2);

// Encode and decode with little-endian
const bufferLE = new Uint8Array(2);
const bytesWrittenLE = f16le.encode(testValue, bufferLE);
const [decodedLE, bytesReadLE] = f16le.decode(bufferLE);

// Use approximate comparison for floating-point precision
assertEquals(Math.abs(decodedLE - testValue) < 0.01, true);
assertEquals(bytesWrittenLE, 2);
assertEquals(bytesReadLE, 2);

Parameters

optional
endianness: Endianness = be

The byte order to use ("be" for big-endian, "le" for little-endian), defaults to "be"

Return Type

Coder<number>

A Coder<number> for 16-bit floating-point numbers

Usage

import { f16 } from "numeric/numeric.ts";