Contents

neighborsForString:maximumCount:maximumDistance:distanceType:

Retrieves a limited number of strings, within a radius of a string, in the vocabulary.

Declaration

- (NSArray<NSString *> *) neighborsForString:(NSString *) string maximumCount:(NSUInteger) maxCount maximumDistance:(NLDistance) maxDistance distanceType:(NLDistanceType) distanceType;

Parameters

  • string:

    A string in the embedding vocabulary.

  • maxCount:

    The largest number of neighboring strings that the method can return in an array.

  • maxDistance:

    The largest distance a neighbor can be from string.

  • distanceType:

    A means of calculating distance that determines which formula the method uses to evaluate a neighbor’s distance from string.

Return Value

An array of neighboring strings.

See Also

Finding strings and their distances in an embedding