use crate::math::MulAdd;
macro_rules! impl_liveness_float {
($name:ident, $builder:ident, $ty:ty) => {
#[derive(Debug, Clone)]
pub struct $name {
alpha: $ty,
one_minus_alpha: $ty,
interval: $ty,
last_timestamp: $ty,
deadline_multiple: Option<$ty>,
deadline_absolute: Option<$ty>,
count: u64,
min_samples: u64,
}
#[doc = stringify!($name)]
#[derive(Debug, Clone)]
pub struct $builder {
alpha: Option<$ty>,
deadline_multiple: Option<$ty>,
deadline_absolute: Option<$ty>,
min_samples: u64,
}
impl $name {
#[inline]
#[must_use]
pub fn builder() -> $builder {
$builder {
alpha: Option::None,
deadline_multiple: Option::None,
deadline_absolute: Option::None,
min_samples: 2,
}
}
#[inline]
#[must_use]
pub fn record(&mut self, timestamp: $ty) -> bool {
self.count += 1;
if self.count == 1 {
self.last_timestamp = timestamp;
return true;
}
let dt = timestamp - self.last_timestamp;
self.last_timestamp = timestamp;
if self.count == 2 {
self.interval = dt;
} else {
self.interval = self.alpha.fma(dt, self.one_minus_alpha * self.interval);
}
if self.count < self.min_samples {
return true;
}
self.is_alive_at_interval(dt)
}
#[inline]
#[must_use]
pub fn check(&self, now: $ty) -> bool {
if self.count < self.min_samples {
return true;
}
let dt = now - self.last_timestamp;
self.is_alive_at_interval(dt)
}
#[inline]
fn is_alive_at_interval(&self, dt: $ty) -> bool {
if let Some(multiple) = self.deadline_multiple {
return dt <= self.interval * multiple;
}
if let Some(absolute) = self.deadline_absolute {
return dt <= absolute;
}
true
}
#[inline]
#[must_use]
pub fn interval(&self) -> Option<$ty> {
if self.count >= 2 {
Option::Some(self.interval)
} else {
Option::None
}
}
#[inline]
#[must_use]
pub fn count(&self) -> u64 {
self.count
}
#[inline]
#[must_use]
pub fn is_primed(&self) -> bool {
self.count >= self.min_samples
}
#[inline]
pub fn reset(&mut self) {
self.interval = 0.0 as $ty;
self.last_timestamp = 0.0 as $ty;
self.count = 0;
}
#[inline]
pub fn reconfigure_deadline_multiple(&mut self, n: $ty) {
self.deadline_multiple = Option::Some(n);
self.deadline_absolute = Option::None;
}
#[inline]
pub fn reconfigure_deadline_absolute(&mut self, t: $ty) {
self.deadline_absolute = Option::Some(t);
self.deadline_multiple = Option::None;
}
}
impl $builder {
#[inline]
#[must_use]
pub fn alpha(mut self, alpha: $ty) -> Self {
self.alpha = Option::Some(alpha);
self
}
#[inline]
#[must_use]
#[cfg(any(feature = "std", feature = "libm"))]
pub fn halflife(mut self, halflife: $ty) -> Self {
let ln2 = core::f64::consts::LN_2 as $ty;
let alpha = 1.0 as $ty - crate::math::exp((-ln2 / halflife) as f64) as $ty;
self.alpha = Option::Some(alpha);
self
}
#[inline]
#[must_use]
pub fn span(mut self, n: u64) -> Self {
let alpha = 2.0 as $ty / (n as $ty + 1.0 as $ty);
self.alpha = Option::Some(alpha);
self
}
#[inline]
#[must_use]
pub fn deadline_multiple(mut self, n: $ty) -> Self {
self.deadline_multiple = Option::Some(n);
self
}
#[inline]
#[must_use]
pub fn deadline_absolute(mut self, t: $ty) -> Self {
self.deadline_absolute = Option::Some(t);
self
}
#[inline]
#[must_use]
pub fn min_samples(mut self, min: u64) -> Self {
self.min_samples = min;
self
}
#[inline]
pub fn build(self) -> Result<$name, crate::ConfigError> {
let alpha = self.alpha.ok_or(crate::ConfigError::Missing("alpha"))?;
if !(alpha > 0.0 as $ty && alpha < 1.0 as $ty) {
return Err(crate::ConfigError::Invalid("Liveness alpha must be in (0, 1)"));
}
if self.deadline_multiple.is_none() && self.deadline_absolute.is_none() {
return Err(crate::ConfigError::Invalid("Liveness requires a deadline (use .deadline_multiple() or .deadline_absolute())"));
}
Ok($name {
alpha,
one_minus_alpha: 1.0 as $ty - alpha,
interval: 0.0 as $ty,
last_timestamp: 0.0 as $ty,
deadline_multiple: self.deadline_multiple,
deadline_absolute: self.deadline_absolute,
count: 0,
min_samples: self.min_samples,
})
}
}
};
}
impl_liveness_float!(LivenessF64, LivenessF64Builder, f64);
impl_liveness_float!(LivenessF32, LivenessF32Builder, f32);
macro_rules! impl_liveness_int {
($name:ident, $builder:ident, $ty:ty, $acc_ty:ty) => {
#[derive(Debug, Clone)]
pub struct $name {
acc: $acc_ty,
shift: u32,
span: u64,
last_timestamp: $ty,
deadline_multiple: Option<u64>,
deadline_absolute: Option<$ty>,
count: u64,
min_samples: u64,
initialized: bool,
}
#[doc = stringify!($name)]
#[derive(Debug, Clone)]
pub struct $builder {
span: Option<u64>,
deadline_multiple: Option<u64>,
deadline_absolute: Option<$ty>,
min_samples: u64,
}
impl $name {
#[inline]
#[must_use]
pub fn builder() -> $builder {
$builder {
span: Option::None,
deadline_multiple: Option::None,
deadline_absolute: Option::None,
min_samples: 2,
}
}
#[inline]
#[must_use]
pub fn record(&mut self, timestamp: $ty) -> bool {
self.count += 1;
if self.count == 1 {
self.last_timestamp = timestamp;
return true;
}
let dt = timestamp - self.last_timestamp;
self.last_timestamp = timestamp;
if !self.initialized {
self.acc = (dt as $acc_ty) << self.shift;
self.initialized = true;
} else {
let dt_shifted = (dt as $acc_ty) << self.shift;
self.acc += (dt_shifted - self.acc) >> self.shift;
}
if self.count < self.min_samples {
return true;
}
let smoothed = (self.acc >> self.shift) as $ty;
self.is_alive_with(dt, smoothed)
}
#[inline]
#[must_use]
pub fn check(&self, now: $ty) -> bool {
if self.count < self.min_samples || !self.initialized {
return true;
}
let dt = now - self.last_timestamp;
let smoothed = (self.acc >> self.shift) as $ty;
self.is_alive_with(dt, smoothed)
}
#[inline]
fn is_alive_with(&self, dt: $ty, smoothed: $ty) -> bool {
if let Some(multiple) = self.deadline_multiple {
return dt <= smoothed * (multiple as $ty);
}
if let Some(absolute) = self.deadline_absolute {
return dt <= absolute;
}
true
}
#[inline]
#[must_use]
pub fn interval(&self) -> Option<$ty> {
if self.count >= 2 && self.initialized {
Option::Some((self.acc >> self.shift) as $ty)
} else {
Option::None
}
}
#[inline]
#[must_use]
pub fn effective_span(&self) -> u64 {
self.span
}
#[inline]
#[must_use]
pub fn count(&self) -> u64 {
self.count
}
#[inline]
#[must_use]
pub fn is_primed(&self) -> bool {
self.count >= self.min_samples
}
#[inline]
pub fn reset(&mut self) {
self.acc = 0;
self.last_timestamp = 0;
self.count = 0;
self.initialized = false;
}
}
impl $builder {
#[inline]
#[must_use]
pub fn span(mut self, n: u64) -> Self {
self.span = Option::Some(n);
self
}
#[inline]
#[must_use]
pub fn deadline_multiple(mut self, n: u64) -> Self {
self.deadline_multiple = Option::Some(n);
self
}
#[inline]
#[must_use]
pub fn deadline_absolute(mut self, t: $ty) -> Self {
self.deadline_absolute = Option::Some(t);
self
}
#[inline]
#[must_use]
pub fn min_samples(mut self, min: u64) -> Self {
self.min_samples = min;
self
}
#[inline]
pub fn build(self) -> Result<$name, crate::ConfigError> {
let requested = self.span.ok_or(crate::ConfigError::Missing("span"))?;
if requested < 1 {
return Err(crate::ConfigError::Invalid("Liveness span must be >= 1"));
}
if self.deadline_multiple.is_none() && self.deadline_absolute.is_none() {
return Err(crate::ConfigError::Invalid("Liveness requires a deadline"));
}
let effective = crate::ema::next_power_of_two_minus_one(requested);
let shift = crate::ema::log2_of_span_plus_one(effective);
Ok($name {
acc: 0,
shift,
span: effective,
last_timestamp: 0,
deadline_multiple: self.deadline_multiple,
deadline_absolute: self.deadline_absolute,
count: 0,
min_samples: self.min_samples,
initialized: false,
})
}
}
};
}
impl_liveness_int!(LivenessI64, LivenessI64Builder, i64, i128);
impl_liveness_int!(LivenessI32, LivenessI32Builder, i32, i64);
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn alive_while_events_arrive() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_multiple(3.0)
.build()
.unwrap();
for i in 0..20 {
assert!(lv.record(i as f64 * 10.0), "should be alive at event {i}");
}
}
#[test]
fn dead_after_silence() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_multiple(3.0)
.build()
.unwrap();
for i in 0..10 {
let _ = lv.record(i as f64 * 10.0);
}
assert!(!lv.check(190.0), "should be dead after long silence");
}
#[test]
fn recovery_after_resume() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_multiple(3.0)
.build()
.unwrap();
for i in 0..10 {
let _ = lv.record(i as f64 * 10.0);
}
assert!(!lv.check(200.0));
assert!(lv.record(200.0)); assert!(lv.record(210.0));
}
#[test]
fn absolute_deadline() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_absolute(50.0)
.build()
.unwrap();
let _ = lv.record(0.0);
let _ = lv.record(10.0);
assert!(lv.check(55.0));
assert!(!lv.check(65.0));
}
#[test]
fn not_primed_always_alive() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_multiple(3.0)
.min_samples(5)
.build()
.unwrap();
assert!(lv.record(0.0));
assert!(lv.record(1000.0));
assert!(!lv.is_primed());
}
#[test]
fn i64_basic() {
let mut lv = LivenessI64::builder()
.span(7)
.deadline_multiple(3)
.build()
.unwrap();
for i in 0..10 {
assert!(lv.record(i * 100));
}
assert!(!lv.check(2000));
}
#[test]
fn i32_basic() {
let mut lv = LivenessI32::builder()
.span(3)
.deadline_absolute(500)
.build()
.unwrap();
let _ = lv.record(0);
let _ = lv.record(100);
assert!(lv.check(400));
assert!(!lv.check(700));
}
#[test]
fn reset_clears_state() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_multiple(3.0)
.build()
.unwrap();
for i in 0..10 {
let _ = lv.record(i as f64 * 10.0);
}
lv.reset();
assert_eq!(lv.count(), 0);
assert!(lv.interval().is_none());
}
#[test]
fn reconfigure_deadline_multiple() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_absolute(50.0)
.build()
.unwrap();
let _ = lv.record(0.0);
let _ = lv.record(10.0);
assert!(lv.check(55.0));
lv.reconfigure_deadline_multiple(2.0);
assert!(!lv.check(55.0));
}
#[test]
fn reconfigure_deadline_absolute() {
let mut lv = LivenessF64::builder()
.alpha(0.3)
.deadline_multiple(3.0)
.build()
.unwrap();
for i in 0..10 {
let _ = lv.record(i as f64 * 10.0);
}
lv.reconfigure_deadline_absolute(5.0);
assert!(!lv.check(100.0));
}
#[test]
fn errors_without_alpha() {
let result = LivenessF64::builder().deadline_multiple(3.0).build();
assert!(matches!(result, Err(crate::ConfigError::Missing("alpha"))));
}
#[test]
fn errors_without_deadline() {
let result = LivenessF64::builder().alpha(0.3).build();
assert!(matches!(result, Err(crate::ConfigError::Invalid(_))));
}
}