File: fstrcmp.3

package info (click to toggle)
fstrcmp 0.7.D001-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,460 kB
  • sloc: sh: 3,493; ansic: 1,505; makefile: 455; awk: 110
file content (61 lines) | stat: -rw-r--r-- 1,998 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.\"
.\" fstrcmp - fuzzy string compare library
.\" Copyright (C) 2009, 2011 Peter Miller
.\" Written by Peter Miller <pmiller@opensource.org.au>
.\"
.\" This program is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 3 of the License, or
.\" (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
.\" General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
.\"
.ds n) fstrcmp
.TH fstrcmp 3
.SH NAME
fstrcmp \- fuzzy comparison of two strings
.if require_index \{
.XX "fstrcmp(3)" "fuzzy comparison of two strings"
.\}
.SH SYNOPSIS
#include <fstrcmp.h>
.sp 0.3
#define FSTRCMP_IDENTICAL
.br
#define FSTRCMP_THRESHOLD
.br
#define FSTRCMP_ERROR
.sp 0.3
double fstrcmp(const char *string1, const char *string2);
.SH DESCRIPTION
The \f[B]fstrcmp\fP() function compares the two strings,
\f[I]string1\fP and \f[I]string2\fP.
.SH RETURN VALUE
The \f[B]fstrcmp\fP function returns a floating point value between
0.0 and FSTRCMP_IDENTICAL.  A value of 0.0 means the strings are
utterly un-alike.  A value of FSTRCMP_IDENTICAL means the strings are
identical.  A value of more than FSTRCMP_THRESHOLD (it lies between 0.0
and FSTRCMP_IDENTICAL) would be considered "similar" by most people.
.PP
A value of FSTRCMP_ERROR (always negative) indicates a \f[I]malloc\fP(3)
failure.
.SH SEE ALSO
.TP 8n
\f[I]fmemcmp\fP(3)
fuzzy comparison of two memory areas
.TP 8n
\f[I]fstrcasecmp\fP(3)
fuzzy comparison of two strings ignoring case
.TP 8n
\f[I]fstrcmpi\fP(3)
fuzzy comparison of two strings
.TP 8n
\f[I]strcmp\fP(3)
compare two strings
.so man/man1/z_copyright.so