bodh 1.0.0

Bodh — psychology engine for cognition, perception, learning, and decision-making
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
//! Psychometrics — measurement of psychological constructs.
//!
//! Reliability, validity, Big Five measurement, Likert scales.

use serde::{Deserialize, Serialize};

use crate::error::{BodhError, Result};

/// An item response with score and confidence.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ItemResponse {
    /// Score for this item (e.g., 1-5 on Likert scale).
    pub score: f32,
    /// Confidence in the response (0.0-1.0).
    pub confidence: f32,
}

/// Big Five personality dimension being measured.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[non_exhaustive]
pub enum BigFiveDimension {
    /// Openness to experience.
    Openness,
    /// Conscientiousness.
    Conscientiousness,
    /// Extraversion.
    Extraversion,
    /// Agreeableness.
    Agreeableness,
    /// Neuroticism.
    Neuroticism,
}

/// Cronbach's alpha: internal consistency reliability.
///
/// `alpha = (k / (k-1)) * (1 - sum(var_i) / var_total)`
///
/// where `k` is the number of items, `var_i` is the variance of each item,
/// and `var_total` is the variance of total scores.
///
/// Alpha >= 0.7 is generally considered acceptable, >= 0.8 good.
///
/// # Errors
///
/// Returns [`BodhError::MeasurementError`] if fewer than 2 items or 2 respondents,
/// or if total variance is zero.
#[must_use = "returns the reliability coefficient without side effects"]
pub fn cronbachs_alpha(items: &[Vec<f32>]) -> Result<f64> {
    let k = items.len();
    if k < 2 {
        return Err(BodhError::MeasurementError(
            "need at least 2 items for Cronbach's alpha".into(),
        ));
    }

    let n = items[0].len();
    if n < 2 {
        return Err(BodhError::MeasurementError(
            "need at least 2 respondents".into(),
        ));
    }

    for item in items {
        if item.len() != n {
            return Err(BodhError::MeasurementError(
                "all items must have the same number of responses".into(),
            ));
        }
    }

    // Compute variance of each item
    let mut sum_item_var = 0.0_f64;
    for item in items {
        sum_item_var += variance_f32(item);
    }

    // Compute total scores for each respondent
    let mut totals = vec![0.0_f64; n];
    for item in items {
        for (j, &score) in item.iter().enumerate() {
            totals[j] += score as f64;
        }
    }

    let var_total = variance_f64(&totals);
    if var_total < f64::EPSILON {
        return Err(BodhError::MeasurementError(
            "total score variance is zero (no variability)".into(),
        ));
    }

    let k_f = k as f64;
    Ok((k_f / (k_f - 1.0)) * (1.0 - sum_item_var / var_total))
}

/// Split-half reliability: correlation between two halves of a test.
///
/// Uses the Spearman-Brown prophecy formula to correct for test length:
/// `r_full = 2 * r_half / (1 + r_half)`
///
/// # Errors
///
/// Returns [`BodhError::MeasurementError`] if fewer than 4 items.
#[must_use = "returns the split-half reliability without side effects"]
pub fn split_half_reliability(items: &[Vec<f32>]) -> Result<f64> {
    if items.len() < 4 {
        return Err(BodhError::MeasurementError(
            "need at least 4 items for split-half reliability".into(),
        ));
    }

    let n = items[0].len();
    for item in items {
        if item.len() != n {
            return Err(BodhError::MeasurementError(
                "all items must have the same number of responses".into(),
            ));
        }
    }

    // Split into odd/even items
    let mut half1 = vec![0.0_f64; n];
    let mut half2 = vec![0.0_f64; n];

    for (i, item) in items.iter().enumerate() {
        let target = if i % 2 == 0 { &mut half1 } else { &mut half2 };
        for (j, &score) in item.iter().enumerate() {
            target[j] += score as f64;
        }
    }

    let r_half = pearson_correlation_f64(&half1, &half2);

    // Spearman-Brown correction
    if (1.0 + r_half).abs() < f64::EPSILON {
        return Err(BodhError::MeasurementError(
            "negative perfect correlation".into(),
        ));
    }
    Ok(2.0 * r_half / (1.0 + r_half))
}

/// Likert scale midpoint.
#[inline]
#[must_use = "returns the midpoint without side effects"]
pub fn likert_midpoint(min: u32, max: u32) -> f64 {
    (min as f64 + max as f64) / 2.0
}

// ---------------------------------------------------------------------------
// Big Five Scoring & Norming
// ---------------------------------------------------------------------------

/// Big Five trait profile: scores on each dimension.
#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
pub struct BigFiveProfile {
    /// Openness to experience (raw score).
    pub openness: f64,
    /// Conscientiousness (raw score).
    pub conscientiousness: f64,
    /// Extraversion (raw score).
    pub extraversion: f64,
    /// Agreeableness (raw score).
    pub agreeableness: f64,
    /// Neuroticism (raw score).
    pub neuroticism: f64,
}

/// Score a Big Five dimension from item responses.
///
/// Items can be positively or negatively keyed. For reverse-scored items,
/// pass the `max_score` (e.g., 5 for a 1–5 Likert scale) and the item
/// indices that are reverse-scored.
///
/// `score = mean(adjusted_items)`
///
/// # Errors
///
/// Returns [`BodhError::MeasurementError`] if items are empty.
#[inline]
#[must_use = "returns the dimension score without side effects"]
pub fn score_dimension(items: &[f32], reverse_keyed: &[usize], max_score: f32) -> Result<f64> {
    if items.is_empty() {
        return Err(BodhError::MeasurementError(
            "need at least 1 item to score".into(),
        ));
    }
    let mut total = 0.0_f64;
    for (i, &score) in items.iter().enumerate() {
        let adjusted = if reverse_keyed.contains(&i) {
            (max_score + 1.0 - score) as f64
        } else {
            score as f64
        };
        total += adjusted;
    }
    Ok(total / items.len() as f64)
}

/// Convert a raw score to a T-score using population norms.
///
/// `T = 50 + 10 × (raw − mean) / std_dev`
///
/// T-scores have mean 50 and SD 10 in the norming population.
///
/// # Errors
///
/// Returns [`BodhError::InvalidParameter`] if `std_dev` is non-positive.
#[inline]
#[must_use = "returns the T-score without side effects"]
pub fn raw_to_t_score(raw: f64, norm_mean: f64, norm_std: f64) -> Result<f64> {
    crate::error::validate_finite(raw, "raw")?;
    crate::error::validate_finite(norm_mean, "norm_mean")?;
    crate::error::validate_positive(norm_std, "norm_std")?;
    Ok(50.0 + 10.0 * (raw - norm_mean) / norm_std)
}

/// Euclidean distance between two Big Five profiles.
///
/// Useful for measuring personality similarity between individuals
/// or between an individual and a prototype.
#[inline]
#[must_use]
pub fn profile_distance(a: &BigFiveProfile, b: &BigFiveProfile) -> f64 {
    let d_o = a.openness - b.openness;
    let d_c = a.conscientiousness - b.conscientiousness;
    let d_e = a.extraversion - b.extraversion;
    let d_a = a.agreeableness - b.agreeableness;
    let d_n = a.neuroticism - b.neuroticism;
    (d_o * d_o + d_c * d_c + d_e * d_e + d_a * d_a + d_n * d_n).sqrt()
}

/// Cosine similarity between two Big Five profiles.
///
/// Returns a value in \[-1, 1\] where 1 = identical shape, 0 = orthogonal,
/// -1 = opposite. Ignores profile elevation (mean level).
#[inline]
#[must_use]
pub fn profile_similarity(a: &BigFiveProfile, b: &BigFiveProfile) -> f64 {
    let a_vec = [
        a.openness,
        a.conscientiousness,
        a.extraversion,
        a.agreeableness,
        a.neuroticism,
    ];
    let b_vec = [
        b.openness,
        b.conscientiousness,
        b.extraversion,
        b.agreeableness,
        b.neuroticism,
    ];

    let dot: f64 = a_vec.iter().zip(&b_vec).map(|(x, y)| x * y).sum();
    let mag_a: f64 = a_vec.iter().map(|x| x * x).sum::<f64>().sqrt();
    let mag_b: f64 = b_vec.iter().map(|x| x * x).sum::<f64>().sqrt();

    if mag_a < 1e-15 || mag_b < 1e-15 {
        return 0.0;
    }
    dot / (mag_a * mag_b)
}

// ---------------------------------------------------------------------------
// Internal helpers
// ---------------------------------------------------------------------------

fn variance_f32(data: &[f32]) -> f64 {
    let n = data.len() as f64;
    if n < 2.0 {
        return 0.0;
    }
    let mean = data.iter().map(|&x| x as f64).sum::<f64>() / n;
    let ss: f64 = data.iter().map(|&x| (x as f64 - mean).powi(2)).sum();
    ss / (n - 1.0) // sample variance
}

fn variance_f64(data: &[f64]) -> f64 {
    let n = data.len() as f64;
    if n < 2.0 {
        return 0.0;
    }
    let mean = data.iter().sum::<f64>() / n;
    let ss: f64 = data.iter().map(|x| (x - mean).powi(2)).sum();
    ss / (n - 1.0)
}

fn pearson_correlation_f64(x: &[f64], y: &[f64]) -> f64 {
    let n = x.len() as f64;
    if n < 2.0 {
        return 0.0;
    }
    let mean_x = x.iter().sum::<f64>() / n;
    let mean_y = y.iter().sum::<f64>() / n;

    let mut cov = 0.0;
    let mut var_x = 0.0;
    let mut var_y = 0.0;

    for i in 0..x.len() {
        let dx = x[i] - mean_x;
        let dy = y[i] - mean_y;
        cov += dx * dy;
        var_x += dx * dx;
        var_y += dy * dy;
    }

    let denom = (var_x * var_y).sqrt();
    if denom < f64::EPSILON {
        return 0.0;
    }
    cov / denom
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_cronbachs_alpha_high_reliability() {
        // Items that correlate highly should produce high alpha.
        let items = vec![
            vec![1.0, 2.0, 3.0, 4.0, 5.0],
            vec![1.1, 2.1, 3.1, 4.1, 5.1],
            vec![0.9, 1.9, 2.9, 3.9, 4.9],
        ];
        let alpha = cronbachs_alpha(&items).unwrap();
        assert!(alpha > 0.95);
    }

    #[test]
    fn test_cronbachs_alpha_low_reliability() {
        // Uncorrelated items should produce low alpha.
        let items = vec![
            vec![5.0, 1.0, 3.0, 2.0, 4.0],
            vec![1.0, 5.0, 2.0, 4.0, 3.0],
            vec![3.0, 2.0, 5.0, 1.0, 4.0],
        ];
        let alpha = cronbachs_alpha(&items).unwrap();
        assert!(alpha < 0.5);
    }

    #[test]
    fn test_cronbachs_alpha_zero_variance() {
        // All identical scores → zero total variance → error.
        let items = vec![vec![3.0, 3.0, 3.0], vec![3.0, 3.0, 3.0]];
        assert!(cronbachs_alpha(&items).is_err());
    }

    #[test]
    fn test_cronbachs_alpha_too_few_items() {
        let items = vec![vec![1.0, 2.0, 3.0]];
        assert!(cronbachs_alpha(&items).is_err());
    }

    #[test]
    fn test_split_half_reliability() {
        let items = vec![
            vec![1.0, 2.0, 3.0, 4.0, 5.0],
            vec![1.1, 2.1, 3.1, 4.1, 5.1],
            vec![0.9, 1.9, 2.9, 3.9, 4.9],
            vec![1.0, 2.0, 3.0, 4.0, 5.0],
        ];
        let r = split_half_reliability(&items).unwrap();
        assert!(r > 0.9);
    }

    #[test]
    fn test_likert_midpoint() {
        assert!((likert_midpoint(1, 5) - 3.0).abs() < 1e-10);
        assert!((likert_midpoint(1, 7) - 4.0).abs() < 1e-10);
    }

    #[test]
    fn test_big_five_serde_roundtrip() {
        let dim = BigFiveDimension::Extraversion;
        let json = serde_json::to_string(&dim).unwrap();
        let back: BigFiveDimension = serde_json::from_str(&json).unwrap();
        assert_eq!(dim, back);
    }

    // -- Big Five scoring --

    #[test]
    fn test_score_dimension_basic() {
        let items = vec![3.0, 4.0, 5.0, 4.0];
        let score = score_dimension(&items, &[], 5.0).unwrap();
        assert!((score - 4.0).abs() < 1e-10);
    }

    #[test]
    fn test_score_dimension_reverse() {
        // Item 1 is reverse-keyed on a 1-5 scale: 2 → 5+1-2 = 4
        let items = vec![3.0, 2.0, 4.0];
        let score = score_dimension(&items, &[1], 5.0).unwrap();
        // (3 + 4 + 4) / 3 ≈ 3.667
        assert!((score - 11.0 / 3.0).abs() < 1e-10);
    }

    #[test]
    fn test_score_dimension_empty() {
        assert!(score_dimension(&[], &[], 5.0).is_err());
    }

    #[test]
    fn test_t_score_at_mean() {
        let t = raw_to_t_score(3.0, 3.0, 1.0).unwrap();
        assert!((t - 50.0).abs() < 1e-10);
    }

    #[test]
    fn test_t_score_one_sd_above() {
        let t = raw_to_t_score(4.0, 3.0, 1.0).unwrap();
        assert!((t - 60.0).abs() < 1e-10);
    }

    #[test]
    fn test_profile_distance_same() {
        let p = BigFiveProfile {
            openness: 3.5,
            conscientiousness: 4.0,
            extraversion: 2.5,
            agreeableness: 3.8,
            neuroticism: 2.0,
        };
        assert!(profile_distance(&p, &p) < 1e-10);
    }

    #[test]
    fn test_profile_distance_different() {
        let a = BigFiveProfile {
            openness: 1.0,
            conscientiousness: 1.0,
            extraversion: 1.0,
            agreeableness: 1.0,
            neuroticism: 1.0,
        };
        let b = BigFiveProfile {
            openness: 5.0,
            conscientiousness: 5.0,
            extraversion: 5.0,
            agreeableness: 5.0,
            neuroticism: 5.0,
        };
        let d = profile_distance(&a, &b);
        // sqrt(5 × 16) = sqrt(80) ≈ 8.944
        assert!((d - 80.0_f64.sqrt()).abs() < 1e-10);
    }

    #[test]
    fn test_profile_similarity_identical() {
        let p = BigFiveProfile {
            openness: 3.0,
            conscientiousness: 4.0,
            extraversion: 2.0,
            agreeableness: 5.0,
            neuroticism: 1.0,
        };
        assert!((profile_similarity(&p, &p) - 1.0).abs() < 1e-10);
    }

    #[test]
    fn test_big_five_profile_serde_roundtrip() {
        let p = BigFiveProfile {
            openness: 3.5,
            conscientiousness: 4.0,
            extraversion: 2.5,
            agreeableness: 3.8,
            neuroticism: 2.0,
        };
        let json = serde_json::to_string(&p).unwrap();
        let back: BigFiveProfile = serde_json::from_str(&json).unwrap();
        assert!((p.openness - back.openness).abs() < 1e-10);
    }

    #[test]
    fn test_item_response_serde_roundtrip() {
        let ir = ItemResponse {
            score: 4.0,
            confidence: 0.8,
        };
        let json = serde_json::to_string(&ir).unwrap();
        let back: ItemResponse = serde_json::from_str(&json).unwrap();
        assert!((ir.score - back.score).abs() < 1e-5);
    }
}