Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@phfaist
phfaist committed Aug 14, 2024
1 parent e1f7fa9 commit 58dc60b
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 16 deletions.
19 changes: 19 additions & 0 deletions scripts/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ some warnings (`ExperimentalWarnings`) that `node` displays.

## List ancestors of a given code

### Simply listing ancestors and code hierarchy tree

List the ancestors tree of the surface code (with CODE_ID "surface"):
```
eczoo_sitegen> yarn node scripts/ancestorsTools list-ancestors surface
Expand All @@ -38,7 +40,24 @@ eczoo_sitegen> yarn node scripts/ancestorsTools list-ancestors --list-by-ancesto
In all cases you can use `--full-names` to show the full names of the codes,
not only the CODE_ID's.

### Detecting degenerate paths in graph

I call "degenerate paths" a set of distinct paths with same start and end points following
the parent relationships. The `ancestorsTools` script provides a routine to find such
paths.

Try:
```
eczoo_sitegen> yarn node scripts/ancestorsTools detect-degenerate-paths --full-names
```

You can also use `--full-names` to get full code names, not just ID's.

You can also inspect the ancestry of one or more specific codes, instead of listing all
degenerate paths one can find in the zoo:
```
eczoo_sitegen> yarn node scripts/ancestorsTools detect-degenerate-paths galois_css,stabilizer
```

## Query bibliographic references in the zoo

Expand Down
46 changes: 30 additions & 16 deletions scripts/ancestorsTools.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ async function run_detect_degenerate_paths(argv)

debuglog('runmain(): zoo is now loaded!');

const { dispCodeLabel, lineWidth, minWrapWidth } = common_args({argv, eczoodb});
const { dispCodeLabel, lineWidth, } = common_args({argv, eczoodb});
const minCellWrapWidth = 8; // arbitrary, makes sure a cell isn't like 2 spaces wide

//
// Zoo is loaded (eczoodb). Query anything we need from it at this point.
Expand Down Expand Up @@ -305,10 +306,13 @@ async function run_detect_degenerate_paths(argv)
outputData = '\n';

for (const dpInfo of Object.values(detectedDegeneratePaths)) {
const { codeIds, paths } = dpInfo;
let { codeIds, paths } = dpInfo;

const codeLabel0 = dispCodeLabel(codeIds[0]);
const codeLabel1 = dispCodeLabel(codeIds[1]);
// switch 0 <-> 1 so we display the ancestor above, and the descendant below
const codeLabel0 = dispCodeLabel(codeIds[1]);
const codeLabel1 = dispCodeLabel(codeIds[0]);
// also reverse all paths for the same reason.
paths = paths.map( (path) => [...path].reverse() );

// Fix the paths: 1) remove endpoints from paths, and 2) prepare the display strings.
let pathsWithDispCodeLabels = paths.map( (path) => path.slice(1, -1).map(
Expand All @@ -318,14 +322,19 @@ async function run_detect_degenerate_paths(argv)
let lineBullet = '* ';
let lineIndent = ' ';

let bulletLabelWrapWidth = lineWidth - lineIndent.length;
if (bulletLabelWrapWidth < minCellWrapWidth) {
bulletLabelWrapWidth = minCellWrapWidth;
}

outputData += wordWrapLines(
`${codeLabel0} → ... → ${codeLabel1}`,
lineWidth - lineIndent.length,
`${codeLabel1} → ... → ${codeLabel0}`,
bulletLabelWrapWidth,
{
firstIndent: lineBullet,
subsequentIndent: lineIndent,
}
).map( x => x+'\n' ).join() + '\n';
).join('\n') + '\n\n';

let nCols = pathsWithDispCodeLabels.length;
let cellGap = 4;
Expand All @@ -342,8 +351,8 @@ async function run_detect_degenerate_paths(argv)
if (cellWidth > maxLabelWidth) {
cellWidth = maxLabelWidth;
}
if (cellWidth < 10) { // sanity check
cellWidth = 10;
if (cellWidth < minCellWrapWidth) { // sanity check
cellWidth = minCellWrapWidth;
}

let cellLWidth = parseInt(Math.floor(cellWidth/2))-1;
Expand All @@ -352,8 +361,8 @@ async function run_detect_degenerate_paths(argv)

let megaCellWidth = cellRWidth + ((cellGap+cellWidth)*(nCols-2)) + cellGap + cellLWidth;
let megaCellLPadding = 2;
if (megaCellWidth < cellWidth+megaCellLPadding) { // sanity check
megaCellWidth = cellWidth+megaCellLPadding;
if (megaCellWidth < minCellWrapWidth+2*megaCellLPadding) { // sanity check
megaCellWidth = minCellWrapWidth+2*megaCellLPadding;
}

debug(`Cell sizes: `, {cellWidth, cellLWidth, cellRWidth, cellGap, megaCellWidth, nCols});
Expand All @@ -364,12 +373,12 @@ async function run_detect_degenerate_paths(argv)

outputData += wordWrapLines(
`${codeLabel0}`,
megaCellWidth - megaCellLPadding,
megaCellWidth - 2*megaCellLPadding,
{
firstIndent: lineIndent + ' '.repeat(cellLWidth+1+megaCellLPadding),
subsequentIndent: lineIndent + ' '.repeat(cellLWidth+1+megaCellLPadding),
}
).map( x => x+'\n' ).join();
).join('\n')+'\n';

outputData += `${lineIndent}${
' '.repeat(cellLWidth) + '/' + '-'.repeat(megaCellWidth) + '\\'
Expand Down Expand Up @@ -430,12 +439,12 @@ async function run_detect_degenerate_paths(argv)

outputData += wordWrapLines(
`${codeLabel1}`,
megaCellWidth - megaCellLPadding,
megaCellWidth - 2*megaCellLPadding,
{
firstIndent: lineIndent + ' '.repeat(cellLWidth+1+megaCellLPadding),
subsequentIndent: lineIndent + ' '.repeat(cellLWidth+1+megaCellLPadding),
}
).map( x => x+'\n' ).join();
).join('\n') + '\n';

outputData += `${lineIndent}${
' '.repeat(cellLWidth) + ' ' + '-'.repeat(megaCellWidth) + ' '
Expand Down Expand Up @@ -765,7 +774,12 @@ await main();
function wordWrapLines(x, width, { minWidth, firstIndent, subsequentIndent }={})
{
debug(`Wrapping: `, {x, width, minWidth});
minWidth ??= 15;
if (!width || width <= 0) {
throw new Error(`wordWrapLines() invalid width=${width}`);
}
if (minWidth == null) {
minWidth = parseInt(Math.floor(width * 0.4));
}
if (width < minWidth) {
throw new Error(`wordWrapLines() invalid width=${width} is less than minWidth=${minWidth}`);
}
Expand Down

0 comments on commit 58dc60b

Please sign in to comment.