annotate docs/modules/txt/FingerprintsBitVector.txt @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 FingerprintsBitVector
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use Fingerprints::FingerprintsBitVector;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use Fingerprints::FingerprintsBitVector qw(:coefficients);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 use Fingerprints::FingerprintsBitVector qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 FingerprintsBitVector class provides the following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 new, BaroniUrbaniSimilarityCoefficient, BuserSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 CosineSimilarityCoefficient, DennisSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 DiceSimilarityCoefficient, FoldFingerprintsBitVectorByDensity,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 FoldFingerprintsBitVectorBySize, ForbesSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 FossumSimilarityCoefficient, GetBitsAsBinaryString,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 GetBitsAsDecimalString, GetBitsAsHexadecimalString,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 GetBitsAsOctalString, GetBitsAsRawBinaryString, GetDescription,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 GetFingerprintsBitDensity, GetID, GetSpecifiedSize,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 GetSupportedSimilarityCoefficients, GetVectorType,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 HamannSimilarityCoefficient, IsFingerprintsBitVector, IsSubSet,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 JacardSimilarityCoefficient, Kulczynski1SimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 Kulczynski2SimilarityCoefficient, MatchingSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 McConnaugheySimilarityCoefficient, NewFromBinaryString,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 NewFromDecimalString, NewFromHexadecimalString, NewFromOctalString,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 NewFromRawBinaryString, OchiaiSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 PearsonSimilarityCoefficient, RogersTanimotoSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 RussellRaoSimilarityCoefficient, SetDescription, SetID,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 SetSpecifiedSize, SetVectorType, SimpsonSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 SkoalSneath1SimilarityCoefficient, SkoalSneath2SimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 SkoalSneath3SimilarityCoefficient, StringifyFingerprintsBitVector,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 TanimotoSimilarityCoefficient, TverskySimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 WeightedTanimotoSimilarityCoefficient,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 WeightedTverskySimilarityCoefficient, YuleSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 The methods available to create fingerprints bit vector from strings and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 to calculate similarity coefficient between two bit vectors can also be
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 invoked as class functions.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 FingerprintsBitVector class is derived from BitVector class which
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 provides the functionality to manipulate bits.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 For two fingerprints bit vectors A and B of same size, let:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 Na = Number of bits set to "1" in A
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 Nb = Number of bits set to "1" in B
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 Nc = Number of bits set to "1" in both A and B
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 Nd = Number of bits set to "0" in both A and B
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52 Nt = Number of bits set to "1" or "0" in A or B (Size of A or B)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 Nt = Na + Nb - Nc + Nd
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 Na - Nc = Number of bits set to "1" in A but not in B
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 Nb - Nc = Number of bits set to "1" in B but not in A
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 Then, various similarity coefficients [ Ref. 40 - 42 ] for a pair of bit
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 vectors A and B are defined as follows:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 BaroniUrbani: ( SQRT( Nc * Nd ) + Nc ) / ( SQRT ( Nc * Nd ) + Nc + ( Na
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 - Nc ) + ( Nb - Nc ) ) ( same as Buser )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 Buser: ( SQRT ( Nc * Nd ) + Nc ) / ( SQRT ( Nc * Nd ) + Nc + ( Na - Nc )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 + ( Nb - Nc ) ) ( same as BaroniUrbani )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 Cosine: Nc / SQRT ( Na * Nb ) (same as Ochiai)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 Dice: (2 * Nc) / ( Na + Nb )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 Dennis: ( Nc * Nd - ( ( Na - Nc ) * ( Nb - Nc ) ) ) / SQRT ( Nt * Na *
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 Nb)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 Forbes: ( Nt * Nc ) / ( Na * Nb )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 Fossum: ( Nt * ( ( Nc - 1/2 ) ** 2 ) / ( Na * Nb )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78 Hamann: ( ( Nc + Nd ) - ( Na - Nc ) - ( Nb - Nc ) ) / Nt
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 Jaccard: Nc / ( ( Na - Nc) + ( Nb - Nc ) + Nc ) = Nc / ( Na + Nb - Nc )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 (same as Tanimoto)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 Kulczynski1: Nc / ( ( Na - Nc ) + ( Nb - Nc) ) = Nc / ( Na + Nb - 2Nc )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 Kulczynski2: ( ( Nc / 2 ) * ( 2 * Nc + ( Na - Nc ) + ( Nb - Nc) ) ) / (
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 ( Nc + ( Na - Nc ) ) * ( Nc + ( Nb - Nc ) ) ) = 0.5 * ( Nc / Na + Nc /
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 Nb )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 Matching: ( Nc + Nd ) / Nt
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 McConnaughey: ( Nc ** 2 - ( Na - Nc ) * ( Nb - Nc) ) / ( Na * Nb )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 Ochiai: Nc / SQRT ( Na * Nb ) (same as Cosine)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 Pearson: ( ( Nc * Nd ) - ( ( Na - Nc ) * ( Nb - Nc ) ) / SQRT ( Na * Nb
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 * ( Na - Nc + Nd ) * ( Nb - Nc + Nd ) )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 RogersTanimoto: ( Nc + Nd ) / ( ( Na - Nc) + ( Nb - Nc) + Nt) = ( Nc +
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 Nd ) / ( Na + Nb - 2Nc + Nt)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 RussellRao: Nc / Nt
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 Simpson: Nc / MIN ( Na, Nb)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 SkoalSneath1: Nc / ( Nc + 2 * ( Na - Nc) + 2 * ( Nb - Nc) ) = Nc / ( 2 *
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 Na + 2 * Nb - 3 * Nc )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 SkoalSneath2: ( 2 * Nc + 2 * Nd ) / ( Nc + Nd + Nt )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110 SkoalSneath3: ( Nc + Nd ) / ( ( Na - Nc ) + ( Nb - Nc ) ) = ( Nc + Nd )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 / ( Na + Nb - 2 * Nc )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 Tanimoto: Nc / ( ( Na - Nc) + ( Nb - Nc ) + Nc ) = Nc / ( Na + Nb - Nc )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 (same as Jaccard)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 Tversky: Nc / ( alpha * ( Na - Nc ) + ( 1 - alpha) * ( Nb - Nc) + Nc ) =
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 Nc / ( alpha * ( Na - Nb ) + Nb)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 Yule: ( ( Nc * Nd ) - ( ( Na - Nc ) * ( Nb - Nc ) ) ) / ( ( Nc * Nd ) +
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 ( ( Na - Nc ) * ( Nb - Nc ) ) )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 The values of Tanimoto/Jaccard and Tversky coefficients are dependent on
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123 only those bit which are set to "1" in both A and B. In order to take
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 into account all bit positions, modified versions of Tanimoto [ Ref. 42
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 ] and Tversky [ Ref. 43 ] have been developed.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 Let:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129 Na' = Number of bits set to "0" in A
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130 Nb' = Number of bits set to "0" in B
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131 Nc' = Number of bits set to "0" in both A and B
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 Tanimoto': Nc' / ( ( Na' - Nc') + ( Nb' - Nc' ) + Nc' ) = Nc' / ( Na' +
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
134 Nb' - Nc' )
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
135
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
136 Tversky': Nc' / ( alpha * ( Na' - Nc' ) + ( 1 - alpha) * ( Nb' - Nc' ) +
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
137 Nc' ) = Nc' / ( alpha * ( Na' - Nb' ) + Nb')
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
138
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
139 Then:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
140
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
141 WeightedTanimoto = beta * Tanimoto + (1 - beta) * Tanimoto'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
142
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
143 WeightedTversky = beta * Tversky + (1 - beta) * Tversky'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
144
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
145 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
146 new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
147 $NewFPBitVector = new Fingerprints::FingerprintsBitVector($Size);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
148
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
149 Creates a new *FingerprintsBitVector* object of size *Size* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
150 returns newly created FingerprintsBitVector. Bit numbers range from
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
151 0 to 1 less than *Size*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
152
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
153 BaroniUrbaniSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
154 $Value = $FingerprintsBitVector->BaroniUrbaniSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
155 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
156 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
157 BaroniUrbaniSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
158 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
159
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
160 Returns value of *BaroniUrbani* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
161 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
162
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
163 BuserSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
164 $Value = $FingerprintsBitVector->BuserSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
165 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
166 $Value = Fingerprints::FingerprintsBitVector::BuserSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
167 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
168
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
169 Returns value of *Buser* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
170 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
171
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
172 CosineSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
173 $Value = $FingerprintsBitVector->CosineSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
174 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
175 $Value = Fingerprints::FingerprintsBitVector::CosineSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
176 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
177
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
178 Returns value of *Cosine* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
179 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
180
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
181 DennisSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
182 $Value = $FingerprintsBitVector->DennisSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
183 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
184 $Value = Fingerprints::FingerprintsBitVector::DennisSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
185 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
186
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
187 Returns value of *Dennis* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
188 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
189
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
190 DiceSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
191 $Value = $FingerprintsBitVector->DiceSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
192 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
193 $Value = Fingerprints::FingerprintsBitVector::DiceSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
194 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
195
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
196 Returns value of *Dice* similarity coefficient between two same size
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
197 *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
198
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
199 FoldFingerprintsBitVectorByDensity
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
200 $FingerprintsBitVector->FoldFingerprintsBitVectorByDensity($Density);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
201
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
202 Folds *FingerprintsBitVector* by recursively reducing its size by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
203 half until bit density of set bits is greater than or equal to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
204 specified *Density* and returns folded *FingerprintsBitVector*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
205
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
206 FoldFingerprintsBitVectorBySize
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
207 $FingerprintsBitVector->FoldFingerprintsBitVectorBySize($Size);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
208
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
209 Folds *FingerprintsBitVector* by recursively reducing its size by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
210 half until size is less than or equal to specified *Size* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
211 returns folded *FingerprintsBitVector*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
212
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
213 ForbesSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
214 $Value = $FingerprintsBitVector->ForbesSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
215 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
216 $Value = Fingerprints::FingerprintsBitVector::ForbesSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
217 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
218
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
219 Returns value of *Forbes* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
220 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
221
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
222 FossumSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
223 $Value = $FingerprintsBitVector->FossumSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
224 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
225 $Value = Fingerprints::FingerprintsBitVector::FossumSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
226 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
227
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
228 Returns value of *Fossum* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
229 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
230
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
231 GetBitsAsBinaryString
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
232 $BinaryASCIIString = $FingerprintsBitVector->GetBitsAsBinaryString();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
233
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
234 Returns fingerprints as a binary ASCII string containing 0s and 1s.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
235
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
236 GetBitsAsHexadecimalString
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
237 $HexadecimalString = $FingerprintsBitVector->GetBitsAsHexadecimalString();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
238
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
239 Returns fingerprints as a hexadecimal string.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
240
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
241 GetBitsAsRawBinaryString
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
242 $RawBinaryString = $FingerprintsBitVector->GetBitsAsRawBinaryString();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
243
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
244 Returns fingerprints as a raw binary string containing packed bit
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
245 values for each byte.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
246
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
247 GetDescription
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
248 $Description = $FingerprintsBitVector->GetDescription();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
249
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
250 Returns a string containing description of fingerprints bit vector.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
251
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
252 GetFingerprintsBitDensity
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
253 $BitDensity = $FingerprintsBitVector->GetFingerprintsBitDensity();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
254
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
255 Returns *BitDensity* of *FingerprintsBitVector* corresponding to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
256 bits set to 1s.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
257
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
258 GetID
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
259 $ID = $FingerprintsBitVector->GetID();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
260
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
261 Returns *ID* of *FingerprintsBitVector*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
262
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
263 GetVectorType
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
264 $VectorType = $FingerprintsBitVector->GetVectorType();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
265
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
266 Returns *VectorType* of *FingerprintsBitVector*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
267
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
268 GetSpecifiedSize
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
269 $Size = $FingerprintsBitVector->GetSpecifiedSize();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
270
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
271 Returns value of specified size for bit vector.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
272
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
273 GetSupportedSimilarityCoefficients
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
274 @SimilarityCoefficient =
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
275 Fingerprints::FingerprintsBitVector::GetSupportedSimilarityCoefficients();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
276
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
277 Returns an array containing names of supported similarity
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
278 coefficients.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
279
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
280 HamannSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
281 $Value = $FingerprintsBitVector->HamannSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
282 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
283 $Value = Fingerprints::FingerprintsBitVector::HamannSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
284 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
285
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
286 Returns value of *Hamann* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
287 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
288
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
289 IsFingerprintsBitVector
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
290 $Status = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
291 IsFingerprintsBitVector($Object);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
292
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
293 Returns 1 or 0 based on whether *Object* is a FingerprintsBitVector
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
294 object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
295
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
296 IsSubSet
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
297 $Status = $FingerprintsBitVector->IsSubSet($OtherFPBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
298 $Status = Fingerprints::FingerprintsBitVector::IsSubSet(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
299 $FPBitVectorA, $FPBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
300
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
301 Returns 1 or 0 based on whether first firngerprints bit vector is a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
302 subset of second fingerprints bit vector.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
303
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
304 For a bit vector to be a subset of another bit vector, both vectors
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
305 must be of the same size and the bit positions set in first vector
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
306 must also be set in the second bit vector.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
307
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
308 JacardSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
309 $Value = $FingerprintsBitVector->JacardSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
310 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
311 $Value = Fingerprints::FingerprintsBitVector::JacardSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
312 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
313
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
314 Returns value of *Jacard* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
315 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
316
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
317 Kulczynski1SimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
318 $Value = $FingerprintsBitVector->Kulczynski1SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
319 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
320 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
321 Kulczynski1SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
322 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
323
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
324 Returns value of *Kulczynski1* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
325 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
326
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
327 Kulczynski2SimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
328 $Value = $FingerprintsBitVector->Kulczynski2SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
329 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
330 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
331 Kulczynski2SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
332 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
333
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
334 Returns value of *Kulczynski2* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
335 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
336
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
337 MatchingSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
338 $Value = $FingerprintsBitVector->MatchingSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
339 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
340 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
341 MatchingSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
342 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
343
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
344 Returns value of *Matching* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
345 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
346
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
347 McConnaugheySimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
348 $Value = $FingerprintsBitVector->McConnaugheySimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
349 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
350 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
351 McConnaugheySimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
352 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
353
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
354 Returns value of *McConnaughey* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
355 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
356
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
357 NewFromBinaryString
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
358 $NewFPBitVector = $FingerprintsBitVector->NewFromBinaryString(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
359 $BinaryString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
360 $NewFPBitVector = Fingerprints::FingerprintsBitVector::NewFromBinaryString(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
361 $BinaryString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
362
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
363 Creates a new *FingerprintsBitVector* using *BinaryString* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
364 returns new FingerprintsBitVector object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
365
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
366 NewFromHexadecimalString
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
367 $NewFPBitVector = $FingerprintsBitVector->NewFromHexadecimalString(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
368 $HexdecimalString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
369 $NewFPBitVector = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
370 NewFromHexadecimalString(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
371 $HexdecimalString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
372
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
373 Creates a new *FingerprintsBitVector* using *HexdecimalString* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
374 returns new FingerprintsBitVector object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
375
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
376 NewFromRawBinaryString
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
377 $NewFPBitVector = $FingerprintsBitVector->NewFromRawBinaryString(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
378 $RawBinaryString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
379 $NewFPBitVector = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
380 NewFromRawBinaryString(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
381 $RawBinaryString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
382
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
383 Creates a new *FingerprintsBitVector* using *RawBinaryString* and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
384 returns new FingerprintsBitVector object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
385
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
386 OchiaiSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
387 $Value = $FingerprintsBitVector->OchiaiSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
388 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
389 $Value = Fingerprints::FingerprintsBitVector::OchiaiSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
390 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
391
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
392 Returns value of *Ochiai* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
393 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
394
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
395 PearsonSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
396 $Value = $FingerprintsBitVector->PearsonSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
397 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
398 $Value = Fingerprints::FingerprintsBitVector::PearsonSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
399 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
400
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
401 Returns value of *Pearson* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
402 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
403
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
404 RogersTanimotoSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
405 $Value = $FingerprintsBitVector->RogersTanimotoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
406 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
407 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
408 RogersTanimotoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
409 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
410
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
411 Returns value of *RogersTanimoto* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
412 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
413
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
414 RussellRaoSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
415 $Value = $FingerprintsBitVector->RussellRaoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
416 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
417 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
418 RussellRaoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
419 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
420
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
421 Returns value of *RussellRao* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
422 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
423
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
424 SetSpecifiedSize
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
425 $FingerprintsBitVector->SetSpecifiedSize($Size);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
426
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
427 Sets specified size for fingerprints bit vector.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
428
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
429 Irrespective of specified size, Perl functions used to handle bit
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
430 data in BitVector class automatically sets the size to the next
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
431 nearest power of 2. *SpecifiedSize* is used by FingerprintsBitVector
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
432 class to process any aribitray size during similarity coefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
433 calculations.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
434
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
435 SetDescription
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
436 $FingerprintsBitVector->SetDescription($Description);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
437
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
438 Sets *Description* of fingerprints bit vector and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
439 *FingerprintsBitVector*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
440
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
441 SetID
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
442 $FingerprintsBitVector->SetID($ID);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
443
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
444 Sets *ID* of fingerprints bit vector and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
445 *FingerprintsBitVector*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
446
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
447 SetVectorType
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
448 $FingerprintsBitVector->SetVectorType($VectorType);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
449
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
450 Sets *VectorType* of fingerprints bit vector and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
451 *FingerprintsBitVector*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
452
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
453 SimpsonSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
454 $Value = $FingerprintsBitVector->SimpsonSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
455 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
456 $Value = Fingerprints::FingerprintsBitVector::SimpsonSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
457 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
458
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
459 Returns value of *Simpson* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
460 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
461
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
462 SkoalSneath1SimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
463 $Value = $FingerprintsBitVector->SkoalSneath1SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
464 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
465 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
466 SkoalSneath1SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
467 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
468
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
469 Returns value of *SkoalSneath1* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
470 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
471
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
472 SkoalSneath2SimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
473 $Value = $FingerprintsBitVector->SkoalSneath2SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
474 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
475 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
476 SkoalSneath2SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
477 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
478
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
479 Returns value of *SkoalSneath2* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
480 same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
481
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
482 SkoalSneath3SimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
483 $Value = $FingerprintsBitVector->SkoalSneath3SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
484 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
485 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
486 SkoalSneath3SimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
487 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
488
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
489 Returns value of *SkoalSneath3* similarity coefficient between two
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
490 same size *FingerprintsBitVectors*
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
491
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
492 StringifyFingerprintsBitVector
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
493 $String = $FingerprintsBitVector->StringifyFingerprintsBitVector();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
494
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
495 Returns a string containing information about
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
496 *FingerprintsBitVector* object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
497
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
498 TanimotoSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
499 $Value = $FingerprintsBitVector->TanimotoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
500 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
501 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
502 TanimotoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
503 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
504
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
505 Returns value of *Tanimoto* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
506 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
507
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
508 TverskySimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
509 $Value = $FingerprintsBitVector->TverskySimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
510 $OtherFingerprintBitVector, $Alpha);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
511 $Value = Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
512 TverskySimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
513 $FingerprintsBitVectorA, $FingerprintBitVectorB, $Alpha);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
514
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
515 Returns value of *Tversky* similarity coefficient between two same
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
516 size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
517
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
518 WeightedTanimotoSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
519 $Value =
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
520 $FingerprintsBitVector->WeightedTanimotoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
521 $OtherFingerprintBitVector, $Beta);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
522 $Value =
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
523 Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
524 WeightedTanimotoSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
525 $FingerprintsBitVectorA, $FingerprintBitVectorB, $Beta);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
526
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
527 Returns value of *WeightedTanimoto* similarity coefficient between
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
528 two same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
529
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
530 WeightedTverskySimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
531 $Value =
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
532 $FingerprintsBitVector->WeightedTverskySimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
533 $OtherFingerprintBitVector, $Alpha, $Beta);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
534 $Value =
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
535 Fingerprints::FingerprintsBitVector::
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
536 WeightedTverskySimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
537 $FingerprintsBitVectorA, $FingerprintBitVectorB, $Alpha, $Beta);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
538
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
539 Returns value of *WeightedTversky* similarity coefficient between
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
540 two same size *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
541
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
542 YuleSimilarityCoefficient
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
543 $Value = $FingerprintsBitVector->YuleSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
544 $OtherFingerprintBitVector);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
545 $Value = Fingerprints::FingerprintsBitVector::YuleSimilarityCoefficient(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
546 $FingerprintsBitVectorA, $FingerprintBitVectorB);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
547
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
548 Returns value of *Yule* similarity coefficient between two same size
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
549 *FingerprintsBitVectors*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
550
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
551 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
552 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
553
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
554 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
555 BitVector.pm, FingerprintsStringUtil.pm, FingerprintsVector.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
556 Vector.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
557
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
558 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
559 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
560
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
561 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
562
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
563 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
564 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
565 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
566 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
567