Merge pull request #1753 from silx-kit/exact-notation

Replace fixed-point with exact notation in Matrix and Compound vis

Author: axelboc

apps/storybook/src/MatrixVis.stories.tsx

@@ -13,7 +13,7 @@ const typedTwoD = toTypedNdArray(twoD, Float32Array);
 const cplxTwoD = mockValues.twoD_cplx();
 
 const formatNum = format('.3e');
-const formatCplx = createComplexFormatter('.2e', true);
+const formatCplx = createComplexFormatter(format('.2e'));
 
 const meta = {
   title: 'Visualizations/MatrixVis',

cypress/snapshots/app.cy.ts/compound_1D.snap.png

@@ -7,7 +7,6 @@ import {
   isIntegerType,
 } from '@h5web/shared/guards';
 import {
-  type ComplexType,
   type CompoundType,
   DTypeClass,
   type NumericType,
@@ -37,30 +36,19 @@ export function createFloatFormatter(
   notation: Notation,
 ): (val: number) => string {
   switch (notation) {
-    case Notation.FixedPoint:
-      return format('.3f');
+    case Notation.Exact:
+      return (val) => val.toString();
     case Notation.Scientific:
       return format('.3e');
     default:
       return format('.5~g');
   }
 }
 
-export function createMatrixComplexFormatter(
+export function getFormatter<T extends PrintableType>(
+  type: T,
   notation: Notation,
-): (val: ScalarValue<ComplexType>) => string {
-  const formatStr =
-    notation === Notation.FixedPoint
-      ? '.2f'
-      : `.3~${notation === Notation.Scientific ? 'e' : 'g'}`;
-
-  return createComplexFormatter(formatStr, true);
-}
-
-export function getFormatter(
-  type: PrintableType,
-  notation: Notation,
-): (val: ScalarValue<PrintableType>) => string; // override distributivity of `ValueFormatter`
+): (val: ScalarValue<T>) => string; // override distributivity of `ValueFormatter`
 
 export function getFormatter(
   type: PrintableType,
@@ -83,10 +71,13 @@ export function getFormatter(
   }
 
   if (isComplexType(type)) {
-    return createMatrixComplexFormatter(notation);
+    return createComplexFormatter(
+      getFormatter(type.realType, notation),
+      getFormatter(type.imagType, notation),
+    );
   }
 
-  return (val: string) => val.toString(); // call `toString()` for safety, in case type cast is wrong
+  return (val: string) => val.toString();
 }
 
 export function getCellWidth(

cypress/snapshots/app.cy.ts/matrix_1D.snap.png

@@ -7,9 +7,9 @@ import {
 } from '@h5web/shared/hdf5-models';
 import { type ValueFormatter } from '@h5web/shared/vis-models';
 import {
+  createComplexFormatter,
   createEnumFormatter,
   formatBool,
-  formatScalarComplex,
 } from '@h5web/shared/vis-utils';
 
 export function getFormatter(
@@ -19,10 +19,6 @@ export function getFormatter(
 export function getFormatter<T extends PrintableType>(
   dataset: Dataset<ArrayShape, T>,
 ): ValueFormatter<PrintableType> {
-  if (hasComplexType(dataset)) {
-    return formatScalarComplex;
-  }
-
   if (hasBoolType(dataset)) {
     return formatBool;
   }
@@ -31,5 +27,9 @@ export function getFormatter<T extends PrintableType>(
     return createEnumFormatter(dataset.type.mapping);
   }
 
+  if (hasComplexType(dataset)) {
+    return createComplexFormatter((val) => val.toString());
+  }
+
   return (val: number | bigint | string) => val.toString();
 }

packages/app/src/vis-packs/core/matrix/utils.ts

@@ -25,7 +25,7 @@ function NotationToggleGroup(props: Props) {
       >
         <ToggleGroup.Btn label="Auto" value={Notation.Auto} />
         <ToggleGroup.Btn label="Scientific" value={Notation.Scientific} />
-        <ToggleGroup.Btn label="Fixed-point" value={Notation.FixedPoint} />
+        <ToggleGroup.Btn label="Exact" value={Notation.Exact} />
       </ToggleGroup>
     </div>
   );

packages/app/src/vis-packs/core/scalar/utils.ts

@@ -1,5 +1,5 @@
 export enum Notation {
   Auto = 'Auto',
   Scientific = 'Scientific',
-  FixedPoint = 'Fixed-point',
+  Exact = 'Exact',
 }

packages/lib/src/toolbar/controls/NotationToggleGroup.tsx

@@ -216,7 +216,7 @@ export interface UnknownType {
 export type ScalarValue<T extends DType = DType> = T extends NumericLikeType
   ?
       | number
-      | (T extends NumericType ? bigint : never) // let providers return bigints
+      | (T extends IntegerType ? bigint : never) // let providers return bigints
       | (T extends BooleanType ? boolean : never) // let providers return booleans
   : T extends StringType
     ? string
@@ -230,7 +230,7 @@ export type ArrayValue<T extends DType = DType> = T extends NumericLikeType
   ?
       | TypedArray
       | number[]
-      | (T extends NumericType ? BigIntTypedArray | bigint[] : never)
+      | (T extends IntegerType ? BigIntTypedArray | bigint[] : never)
       | (T extends BooleanType ? boolean[] : never) // don't use `ScalarValue` to avoid `(number | boolean)[]`
   : ScalarValue<T>[];
 

packages/lib/src/vis/matrix/models.ts

@@ -39,7 +39,7 @@ export const formatBound = format('.3~e');
 export const formatBoundInput = format('.5~e');
 export const formatTooltipVal = format('.5~g');
 export const formatTooltipErr = format('.3~g');
-export const formatScalarComplex = createComplexFormatter('.12~g');
+export const formatScalarComplex = createComplexFormatter(format('.12~g'));
 
 const TICK_PRECISION = 3;
 const TICK_DECIMAL_REGEX = /0\.(\d+)$/u; // can start with minus sign
@@ -64,24 +64,13 @@ export function formatBool(value: ScalarValue<BooleanType>): string {
 }
 
 export function createComplexFormatter(
-  specifier: string,
-  full = false,
+  formatReal: (val: number) => string,
+  formatImag = formatReal,
 ): (val: ScalarValue<ComplexType>) => string {
-  const formatVal = format(specifier);
-
   return (value) => {
     const [real, imag] = value;
-
-    if (imag === 0 && !full) {
-      return formatVal(real);
-    }
-
-    if (real === 0 && !full) {
-      return `${formatVal(imag)} i`;
-    }
-
     const sign = Math.sign(imag) >= 0 ? ' + ' : ' − ';
-    return `${formatVal(real)}${sign}${formatVal(Math.abs(imag))} i`;
+    return `${formatReal(real)}${sign}${formatImag(Math.abs(imag))} i`;
   };
 }