1\" Generated by c2man from bl_chrom_name_cmp.c
2.TH bl_chrom_name_cmp 3
3
4.SH LIBRARY
5\" Indicate #includes, library name, -L and -l flags
6.nf
7.na
8#include <biolibc/biolibc.h>
9-lbiolibc -lxtend
10.ad
11.fi
12
13\" Convention:
14\" Underline anything that is typed verbatim - commands, etc.
15.SH SYNOPSIS
16.PP
17int     bl_chrom_name_cmp(const char *name1, const char *name2)
18
19.SH ARGUMENTS
20.nf
21.na
22name1, name2    Names of two chroms
23.ad
24.fi
25
26.SH DESCRIPTION
27
28Perform a numeric comparison of two chrom names.
29
30The names may contain a prefix of non-digits, such as "chr".
31Characters that follow must be a chrom number or letter.
32Numbers are considered less than letters (e.g. 22 < X).  As such,
33if either is a letter, they are compared lexically.  If both are
34numbers, they are converted to integers and compared numerically.
35
36Use bl_chrom_name_cmp() only if you need to know which string is
37< or >.  If only checking for equality/inequality, strcmp() will be
38faster.
39
40.SH RETURN VALUES
41
42A value < 1 if name1 is numerically < name2
43A value > 1 if name1 is numerically > name2
440 if name1 == name2
45
46.SH SEE ALSO
47
48strcmp(3)
49
50