BitVecCorrelation

Documentation

API Reference

BitVecCorrelation

Description

Calculate Pearson correlation coefficient between two bitvectors. Treats bits as 0/1 values and computes linear correlation.

Parameters

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

Usage example (from documentation)

  double correlation = BitVecCorrelation(&bv1, &bv2);

Returns

Correlation coefficient (-1.0 to 1.0)

Usage example (Cross-references)

Usage examples (Cross-references)

In BitVec.c:1297:

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

In BitVec.Math.c:400:

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

In BitVec.Math.c:416:

        BitVecPush(&bv2, false);
    
        double correlation = BitVecCorrelation(&bv1, &bv2);
        result             = result && (fabs(correlation - 1.0) < 0.001);

In BitVec.Math.c:426:

        BitVecPush(&bv2, true);
    
        correlation = BitVecCorrelation(&bv1, &bv2);
        result      = result && (fabs(correlation + 1.0) < 0.001);

In BitVec.Math.c:436:

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

In BitVec.Math.c:443:

    
        // Test empty bitvectors
        double correlation = BitVecCorrelation(&bv1, &bv2);
        result             = result && (correlation == 1.0);

In BitVec.Math.c:454:

        BitVecPush(&bv2, true);
    
        correlation = BitVecCorrelation(&bv1, &bv2);
        result      = result && (correlation == 0.0); // No variance

In BitVec.Math.c:645:

        double cosine      = BitVecCosineSimilarity(&bv1, &bv2);
        u64    dot_prod    = BitVecDotProduct(&bv1, &bv2);
        double correlation = BitVecCorrelation(&bv1, &bv2);
        double entropy1    = BitVecEntropy(&bv1);
        int    align_score = BitVecAlignmentScore(&bv1, &bv2, 1, -1);

In BitVec.Math.c:770:

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

In BitVec.Math.c:773:

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

In BitVec.Math.c:779:

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

In BitVec.Math.c:782:

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

Last updated on April 20, 2026

BitVecCompareRange BitVecCosineSimilarity