BitVecHammingDistance

Function
October 8, 2025

Table of Contents

`BitVecHammingDistance`

Description

Calculate Hamming distance between two bitvectors. Hamming distance is the number of positions where bits differ.

Parameters

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

Usage example (from documentation)

  u64 distance = BitVecHammingDistance(&bv1, &bv2);

Usage example (Cross-references)

In BitVec.c:1161:

    // Math functions implementation
    
    u64 BitVecHammingDistance(BitVec *bv1, BitVec *bv2) {
    ValidateBitVec(bv1);
    ValidateBitVec(bv2);

In BitVec.Math.c:53:

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

In BitVec.Math.c:67:

    BitVecPush(&bv2, true);
    
    u64 distance = BitVecHammingDistance(&bv1, &bv2);
    result       = result && (distance == 0);

In BitVec.Math.c:76:

    BitVecPush(&bv2, false);
    
    distance = BitVecHammingDistance(&bv1, &bv2);
    result   = result && (distance == 3);

In BitVec.Math.c:85:

    BitVecPush(&bv2, true); // Same
    
    distance = BitVecHammingDistance(&bv1, &bv2);
    result   = result && (distance == 1);

In BitVec.Math.c:95:

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

In BitVec.Math.c:102:

    
    // Test empty bitvectors
    u64 distance = BitVecHammingDistance(&bv1, &bv2);
    result       = result && (distance == 0);

In BitVec.Math.c:110:

    BitVecPush(&bv2, true);
    
    distance = BitVecHammingDistance(&bv1, &bv2);
    result   = result && (distance == 1); // 1 length difference

In BitVec.Math.c:115:

    // Test one empty, one non-empty
    BitVecClear(&bv2);
    distance = BitVecHammingDistance(&bv1, &bv2);
    result   = result && (distance == 2); // Length of bv1

In BitVec.Math.c:641:

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

In BitVec.Math.c:680:

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

In BitVec.Math.c:683:

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

In BitVec.Math.c:689:

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

In BitVec.Math.c:692:

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

BitVecHammingDistance

`BitVecHammingDistance`

Description

Parameters

Usage example (from documentation)

Usage example (Cross-references)

Tags :

Share :

Related Posts

MAX2

BitVecPush

BitVecInsertMultiple