@stdlib/string/base/distances/docs/types/index.d.ts

String manipulation functions.

/*
* @license Apache-2.0
*
* Copyright (c) 2023 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

// TypeScript Version: 4.1

/* eslint-disable max-lines */

import hammingDistance = require( './../../../../base/distances/hamming' );
import levenshteinDistance = require( './../../../../base/distances/levenshtein' );

/**
* Interface describing the `distances` namespace.
*/
interface Namespace {
	/**
	* Calculates the Hamming distance between two equal-length strings.
	*
	* ## Notes
	*
	* -   The function returns a sentinel value of `-1` if the input string lengths differ.
	*
	* @param str1 - first input string
	* @param str2 - second input string
	* @returns Hamming distance
	*
	* @example
	* var dist = ns.hammingDistance( 'fly', 'ant' );
	* // returns 3
	*
	* @example
	* var dist = ns.hammingDistance( 'algorithms', 'altruistic' );
	* // returns 7
	*
	* @example
	* var dist = ns.hammingDistance( 'hippopod', 'elephant' );
	* // returns 7
	*/
	hammingDistance: typeof hammingDistance;

	/**
	* Calculates the Levenshtein (edit) distance between two strings.
	*
	* @param str1 - first string value
	* @param str2 - second string value
	* @returns Levenshtein distance
	*
	* @example
	* var dist = ns.levenshteinDistance( 'fly', 'ant' );
	* // returns 3
	*
	* @example
	* var dist = ns.levenshteinDistance( 'algorithm', 'altruistic' );
	* // returns 6
	*
	* @example
	* var dist = ns.levenshteinDistance( 'hippo', 'elephant' );
	* // returns 7
	*/
	levenshteinDistance: typeof levenshteinDistance;
}

/**
* Implementations of various string similarity metrics.
*/
declare var ns: Namespace;


// EXPORTS //

export = ns;