BitVecJaccardSimilarity

Documentation

API Reference

Description

Calculate Jaccard similarity between two bitvectors. Jaccard similarity = |intersection| / |union|

Parameters

Name	Direction	Description
`bv1`	in	First bitvector
`bv2`	in	Second bitvector

Usage example (from documentation)

  double similarity = BitVecJaccardSimilarity(&bv1, &bv2);

Returns

Jaccard similarity coefficient (0.0 to 1.0)

Usage example (Cross-references)

Usage examples (Cross-references)

In BitVec.c:1182:

    }
    
    double BitVecJaccardSimilarity(BitVec *bv1, BitVec *bv2) {
        ValidateBitVec(bv1);
        ValidateBitVec(bv2);

In BitVec.Math.c:125:

    // Test BitVecJaccardSimilarity basic functionality
    bool test_bitvec_jaccard_similarity_basic(void) {
        WriteFmt("Testing BitVecJaccardSimilarity basic functionality\n");
    
        BitVec bv1    = BitVecInit();

In BitVec.Math.c:139:

        BitVecPush(&bv2, true);
    
        double similarity = BitVecJaccardSimilarity(&bv1, &bv2);
        result            = result && (fabs(similarity - 1.0) < 0.001);

In BitVec.Math.c:150:

        BitVecPush(&bv2, true);
    
        similarity = BitVecJaccardSimilarity(&bv1, &bv2);
        result     = result && (fabs(similarity - 0.0) < 0.001);

In BitVec.Math.c:164:

        // Intersection: 1, Union: 2, Jaccard = 1/2 = 0.5
    
        similarity = BitVecJaccardSimilarity(&bv1, &bv2);
        result     = result && (fabs(similarity - 0.5) < 0.001);

In BitVec.Math.c:174:

    // Test BitVecJaccardSimilarity edge cases
    bool test_bitvec_jaccard_similarity_edge_cases(void) {
        WriteFmt("Testing BitVecJaccardSimilarity edge cases\n");
    
        BitVec bv1    = BitVecInit();

In BitVec.Math.c:181:

    
        // Test empty bitvectors
        double similarity = BitVecJaccardSimilarity(&bv1, &bv2);
        result            = result && (fabs(similarity - 1.0) < 0.001);

In BitVec.Math.c:190:

        BitVecPush(&bv2, false);
    
        similarity = BitVecJaccardSimilarity(&bv1, &bv2);
        result     = result && (fabs(similarity - 1.0) < 0.001);

In BitVec.Math.c:642:

        // Test that all functions complete without crashing
        u64    hamming     = BitVecHammingDistance(&bv1, &bv2);
        double jaccard     = BitVecJaccardSimilarity(&bv1, &bv2);
        double cosine      = BitVecCosineSimilarity(&bv1, &bv2);
        u64    dot_prod    = BitVecDotProduct(&bv1, &bv2);

In BitVec.Math.c:698:

    
    bool test_bitvec_jaccard_similarity_null_bv1(void) {
        WriteFmt("Testing BitVecJaccardSimilarity(NULL, bv2) - should fatal\n");
        BitVec bv2 = BitVecInit();
        BitVecPush(&bv2, true);

In BitVec.Math.c:701:

        BitVec bv2 = BitVecInit();
        BitVecPush(&bv2, true);
        BitVecJaccardSimilarity(NULL, &bv2);
        BitVecDeinit(&bv2);
        return true;

In BitVec.Math.c:707:

    
    bool test_bitvec_jaccard_similarity_null_bv2(void) {
        WriteFmt("Testing BitVecJaccardSimilarity(bv1, NULL) - should fatal\n");
        BitVec bv1 = BitVecInit();
        BitVecPush(&bv1, true);

In BitVec.Math.c:710:

        BitVec bv1 = BitVecInit();
        BitVecPush(&bv1, true);
        BitVecJaccardSimilarity(&bv1, NULL);
        BitVecDeinit(&bv1);
        return true;

Last updated on April 20, 2026

BitVecIsSuperset BitVecNumericalCompare