classTextGeneralization

packages/sql-catalog/src/Core/Text/TextGeneralization.php:19

final class TextGeneralization

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Collapses several patterns into the one shape that covers all of them.

Joining branches or iterations of a loop can produce more strings than a catalog should list. Generalization keeps the text the alternatives agree on and replaces the part they disagree on with a single gap, so the reported shape still matches every string the code can build.

Properties§

public Origin $origin

source §

Methods§

public function __construct(public Origin $origin)

source §

Parameters

$origin Origin The origin recorded on gaps this generalization introduces

public function merge(TextPattern $left, TextPattern $right): TextPattern

source §

The narrowest pattern that covers both inputs.

Parameters

`$left`	`TextPattern`
`$right`	`TextPattern`

Returns

TextPattern

Test cases 3

Called from 1

method-call SqlCatalog\Core\Text\TextGeneralization::mergeAll() packages/sql-catalog/src/Core/Text/TextGeneralization.php:104

Calls 13

method-call TextPattern::equals() line 33
method-call TextGeneralization::mergeResolved() line 37
method-call TextGeneralization::atoms() line 42
method-call TextGeneralization::commonPrefixLength() line 44
function-call min line 45
function-call count line 45
method-call TextGeneralization::commonSuffixLength() line 46
function-call array_merge line 48
method-call TextGeneralization::rebuild() line 49
function-call array_slice line 49
new TextHole line 50
method-call TextGeneralization::gapType() line 50
static-call TextPattern::fromSegments() line 54

public function mergeResolved(TextPattern $left, TextPattern $right): ?TextPattern

source §

The narrowest pattern covering two fully resolved strings, or null when either has a gap.

Statements are long and are merged often, so the common case of two resolved strings is answered by comparing the strings themselves rather than by walking them character by character.

Parameters

`$left`	`TextPattern`
`$right`	`TextPattern`

Returns

?TextPattern

Test cases 1

TextGeneralizationTest::testMergeResolvedAnswersOnlyForTwoResolvedStrings calls

Called from 1

method-call SqlCatalog\Core\Text\TextGeneralization::merge() packages/sql-catalog/src/Core/Text/TextGeneralization.php:37

Calls 10

method-call TextPattern::text() line 66
method-call TextGeneralization::sharedPrefixLength() line 72
function-call min line 73
function-call strlen line 73
function-call strrev line 74
static-call TextPattern::fromSegments() line 76
new LiteralText line 77
function-call substr line 77
new TextHole line 78
static-call TypeShape::of() line 78

public function sharedPrefixLength(string $left, string $right): int

source §

How many leading bytes two strings share.

Parameters

`$left`	`string`
`$right`	`string`

Returns

int

Test cases 1

TextGeneralizationTest::testSharedPrefixLengthCountsTheLeadingBytesTwoStringsShare calls

Called from 2

Calls 1

function-call strspn line 88

public function mergeAll(list<TextPattern> $patterns): TextPattern

source §

The narrowest pattern that covers every input.

Parameters

$patterns list<TextPattern>

Returns

TextPattern

Test cases 2

Called from 1

method-call SqlCatalog\Core\Evaluation\Domain::generalize() packages/sql-catalog/src/Core/Evaluation/Domain.php:111

Calls 3

function-call array_shift line 98
static-call TextPattern::empty() line 100
method-call TextGeneralization::merge() line 104

public function atoms(TextPattern $pattern): list<string|TextHole>

source §

The pattern split into single characters and whole gaps, so the two sides align.

Parameters

$pattern TextPattern

Returns

list<string|TextHole>

Test cases 1

TextGeneralizationTest::testAtomsSplitTextIntoCharactersAndKeepGapsWhole calls

Called from 2

Calls 1

function-call strlen line 126

public function commonPrefixLength(
    list<string|TextHole> $left,
    list<string|TextHole> $right,
): int

source §

How many leading atoms the two sides share.

Parameters

`$left`	`list<string\|TextHole>`
`$right`	`list<string\|TextHole>`

Returns

int

Test cases 1

TextGeneralizationTest::testCommonPrefixLengthCountsSharedLeadingAtoms calls

Called from 1

method-call SqlCatalog\Core\Text\TextGeneralization::merge() packages/sql-catalog/src/Core/Text/TextGeneralization.php:44

Calls 3

function-call min line 143
function-call count line 143
method-call TextGeneralization::sameAtom() line 145

public function commonSuffixLength(
    list<string|TextHole> $left,
    list<string|TextHole> $right,
    int $limit,
): int

source §

How many trailing atoms the two sides share, without reaching into the prefix.

Parameters

`$left`	`list<string\|TextHole>`
`$right`	`list<string\|TextHole>`
`$limit`	`int`	The atoms still available after the shared prefix

Returns

int

Test cases 1

TextGeneralizationTest::testCommonSuffixLengthStopsAtTheGivenLimit calls

Called from 1

method-call SqlCatalog\Core\Text\TextGeneralization::merge() packages/sql-catalog/src/Core/Text/TextGeneralization.php:46

Calls 2

function-call count line 161
method-call TextGeneralization::sameAtom() line 166

public function sameAtom(string|TextHole $left, string|TextHole $right): bool

source §

Whether two atoms stand for the same thing.

Parameters

`$left`	`string\|TextHole`
`$right`	`string\|TextHole`

Returns

bool

Test cases 1

TextGeneralizationTest::testSameAtomComparesGapsByOrigin calls

Called from 2

public function rebuild(list<string|TextHole> $atoms): list<TextSegment>

source §

Segments rebuilt from atoms.

Parameters

$atoms list<string|TextHole>

Returns

list<TextSegment>

Test cases 1

TextGeneralizationTest::testRebuildTurnsAtomsBackIntoSegments calls

Called from 2

Calls 1

new LiteralText line 201

public function gapType(TextPattern $left, TextPattern $right): TypeShape

source §

The type recorded on the introduced gap.

Parameters

`$left`	`TextPattern`
`$right`	`TextPattern`

Returns

TypeShape

Test cases 1

TextGeneralizationTest::testGapTypeIsAStringOnlyWhenBothSidesResolved calls

Called from 1

method-call SqlCatalog\Core\Text\TextGeneralization::merge() packages/sql-catalog/src/Core/Text/TextGeneralization.php:50

Calls 3

method-call TextPattern::isExact() line 212
static-call TypeShape::of() line 212
static-call TypeShape::unknown() line 212

Test cases 33§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 13

Other tests reaching this symbol 20

Relations§

Instantiated in 1

new SqlCatalog\Core\Evaluation\Domain::generalize() packages/sql-catalog/src/Core/Evaluation/Domain.php:111

Method calls 1

method-call SqlCatalog\Core\Evaluation\Domain::generalize() packages/sql-catalog/src/Core/Evaluation/Domain.php:111