fits-well 0.1.4

use super::*;
use crate::header::from_card_lines as header;

fn image(samples: ImageData, scaling: Scaling) -> Image {
    Image {
        shape: vec![samples.len()],
        samples,
        scaling,
    }
}

/// Encode to a fresh buffer — the allocating shorthand over `encode_into` the
/// round-trip tests read against.
fn encoded(data: &ImageData) -> Vec<u8> {
    let mut out = Vec::new();
    data.encode_into(&mut out);
    out
}

#[test]
fn decodes_big_endian_integers_and_floats() {
    // i16: 0x0001=1, 0xFFFF=-1, 0x8000=-32768 (the unsigned-u16 min sentinel).
    assert_eq!(
        ImageData::decode(&[0x00, 0x01, 0xFF, 0xFF, 0x80, 0x00], Bitpix::I16),
        ImageData::I16(vec![1, -1, -32768])
    );
    // BITPIX=8 is raw bytes, no byte order.
    assert_eq!(
        ImageData::decode(&[1, 2, 3], Bitpix::U8),
        ImageData::U8(vec![1, 2, 3])
    );
    // i32 0x00000100 = 256.
    assert_eq!(
        ImageData::decode(&[0, 0, 1, 0], Bitpix::I32),
        ImageData::I32(vec![256])
    );
    // i64 = 5.
    assert_eq!(
        ImageData::decode(&[0, 0, 0, 0, 0, 0, 0, 5], Bitpix::I64),
        ImageData::I64(vec![5])
    );
    // f32 1.0 = 0x3F800000, f64 1.0 = 0x3FF0000000000000.
    assert_eq!(
        ImageData::decode(&[0x3F, 0x80, 0x00, 0x00], Bitpix::F32),
        ImageData::F32(vec![1.0])
    );
    assert_eq!(
        ImageData::decode(&[0x3F, 0xF0, 0, 0, 0, 0, 0, 0], Bitpix::F64),
        ImageData::F64(vec![1.0])
    );
}

#[test]
fn encode_produces_big_endian_bytes() {
    assert_eq!(
        encoded(&ImageData::I16(vec![1, -1])),
        vec![0x00, 0x01, 0xFF, 0xFF]
    );
    assert_eq!(encoded(&ImageData::U8(vec![1, 2, 3])), vec![1, 2, 3]);
}

#[test]
fn encode_is_the_inverse_of_decode() {
    let cases = [
        ImageData::U8(vec![0, 1, 255]),
        ImageData::I16(vec![1, -1, -32768, 32767]),
        ImageData::I32(vec![256, -1, i32::MIN]),
        ImageData::I64(vec![5, -5, i64::MAX]),
        ImageData::F32(vec![1.0, -2.5, 0.0]),
        ImageData::F64(vec![1.0, -2.5, f64::MAX]),
    ];
    for data in cases {
        let bytes = encoded(&data);
        assert_eq!(ImageData::decode(&bytes, data.bitpix()), data);
    }
}

#[test]
fn swap_into_words_then_view_matches_decode_and_reuses_one_alloc() {
    // The reader's view path: swap big-endian bytes into a u64-backed scratch, then
    // reinterpret as a typed ImageView. Each type's view must equal the owned decode,
    // and the cross-BITPIX scratch must reuse one allocation across types.
    let cases = [
        ImageData::I16(vec![1, -1, -32768, 32767]),
        ImageData::I32(vec![256, -1, i32::MIN]),
        ImageData::I64(vec![5, -5, i64::MAX]),
        ImageData::F32(vec![1.0, -2.5, 0.0]),
        ImageData::F64(vec![1.0, -2.5, f64::MAX]),
    ];
    let mut words: Vec<u64> = Vec::new();
    for data in &cases {
        let be = encoded(data);
        swap_into_words(&be, data.bitpix(), &mut words);
        let view = view_words(&words, data.bitpix(), be.len());
        // The view's samples equal the owned decode (compare via a fresh ImageData).
        let owned = ImageData::decode(&be, data.bitpix());
        let view_owned = match view {
            ImageView::I16(v) => ImageData::I16(v.to_vec()),
            ImageView::I32(v) => ImageData::I32(v.to_vec()),
            ImageView::I64(v) => ImageData::I64(v.to_vec()),
            ImageView::F32(v) => ImageData::F32(v.to_vec()),
            ImageView::F64(v) => ImageData::F64(v.to_vec()),
            ImageView::U8(v) => ImageData::U8(v.to_vec()),
        };
        assert_eq!(
            view_owned,
            owned,
            "view of {:?} must equal decode",
            data.bitpix()
        );
    }

    // Cross-BITPIX reuse: two equal-byte-length decodes of *different* types must
    // reuse the same u64 backing (no realloc) — the page-fault-free property the
    // reader's scratch relies on. 4096 bytes = 2048 i16 then 1024 i32.
    let i16s = ImageData::I16((0..2048).map(|i| i as i16).collect());
    let i32s = ImageData::I32((0..1024).map(|i| i - 7).collect());
    let mut w: Vec<u64> = Vec::new();
    swap_into_words(&encoded(&i16s), Bitpix::I16, &mut w);
    let ptr1 = w.as_ptr();
    swap_into_words(&encoded(&i32s), Bitpix::I32, &mut w);
    let ptr2 = w.as_ptr();
    assert_eq!(
        ptr1, ptr2,
        "equal-length cross-type swap must reuse the scratch"
    );
    // ...and the i32 view is still correct after reusing the i16 scratch.
    let view = view_words(&w, Bitpix::I32, encoded(&i32s).len());
    assert_eq!(
        view,
        ImageView::I32(&(0..1024).map(|i| i - 7).collect::<Vec<i32>>())
    );
}

#[test]
fn float_inf_and_nan_payloads_round_trip_bit_for_bit() {
    // §3.4 / Appendix E mandate preserving ±Inf and signaling/quiet NaN payloads
    // without canonicalizing. PartialEq can't compare NaN, so check raw bits.
    let f32_bits: [u32; 5] = [
        0x7F80_0000, // +Inf
        0xFF80_0000, // -Inf
        0x7FC0_0000, // quiet NaN
        0x7F80_0001, // signaling NaN, payload 1
        0x7FAB_CDEF, // NaN with a payload
    ];
    let f32s: Vec<f32> = f32_bits.iter().map(|&b| f32::from_bits(b)).collect();
    let decoded = ImageData::decode(&encoded(&ImageData::F32(f32s)), Bitpix::F32);
    let ImageData::F32(out) = decoded else {
        panic!("expected F32")
    };
    for (i, (&b, o)) in f32_bits.iter().zip(&out).enumerate() {
        assert_eq!(o.to_bits(), b, "f32 pattern {i}");
    }

    let f64_bits: [u64; 5] = [
        0x7FF0_0000_0000_0000, // +Inf
        0xFFF0_0000_0000_0000, // -Inf
        0x7FF8_0000_0000_0000, // quiet NaN
        0x7FF0_0000_0000_0001, // signaling NaN, payload 1
        0x7FF0_0000_DEAD_BEEF, // NaN with a payload
    ];
    let f64s: Vec<f64> = f64_bits.iter().map(|&b| f64::from_bits(b)).collect();
    let decoded = ImageData::decode(&encoded(&ImageData::F64(f64s)), Bitpix::F64);
    let ImageData::F64(out) = decoded else {
        panic!("expected F64")
    };
    for (i, (&b, o)) in f64_bits.iter().zip(&out).enumerate() {
        assert_eq!(o.to_bits(), b, "f64 pattern {i}");
    }
}

#[test]
fn physical_applies_scaling_and_maps_blank_to_nan() {
    // 10 -> 5 + 2·10 = 25 ; 20 == BLANK -> NaN ; -5 -> 5 + 2·-5 = -5
    let img = image(
        ImageData::I16(vec![10, 20, -5]),
        Scaling {
            bscale: 2.0,
            bzero: 5.0,
            blank: Some(20),
        },
    );
    let phys = img.physical();
    assert_eq!(phys[0], 25.0);
    assert!(phys[1].is_nan());
    assert_eq!(phys[2], -5.0);
}

#[test]
fn physical_f32_is_the_single_pass_narrowing_of_physical() {
    // Same fixture as physical: 10 -> 25, 20 == BLANK -> NaN, -5 -> -5.
    let img = image(
        ImageData::I16(vec![10, 20, -5]),
        Scaling {
            bscale: 2.0,
            bzero: 5.0,
            blank: Some(20),
        },
    );
    let f32s = img.physical_f32();
    assert_eq!(f32s[0], 25.0_f32);
    assert!(f32s[1].is_nan());
    assert_eq!(f32s[2], -5.0_f32);

    // It equals the f64 plane narrowed element-wise, even where f32 must round:
    // BSCALE = 0.1 is not representable, so the scaling accrues error that the
    // shared f64 evaluation then narrows identically in both methods.
    let rounded = image(
        ImageData::I32(vec![0, 7, 123_456_789]),
        Scaling {
            bscale: 0.1,
            bzero: 0.0,
            blank: None,
        },
    );
    let via_f64: Vec<f32> = rounded.physical().into_iter().map(|v| v as f32).collect();
    assert_eq!(rounded.physical_f32(), via_f64);
}

#[test]
fn unsigned_view_recovers_exact_typed_integers() {
    // Signed storage + the matching BZERO offset decodes back to the unsigned (or
    // signed-byte) values by flipping the stored sign bit.
    let u16_img = image(
        ImageData::I16(vec![-32768, 0, 32767]),
        Scaling {
            bscale: 1.0,
            bzero: 32768.0,
            blank: None,
        },
    );
    assert_eq!(
        u16_img.unsigned(),
        Some(UnsignedView::U16(vec![0, 32768, 65535]))
    );
    let u32_img = image(
        ImageData::I32(vec![i32::MIN, 0, i32::MAX]),
        Scaling {
            bscale: 1.0,
            bzero: 2_147_483_648.0,
            blank: None,
        },
    );
    assert_eq!(
        u32_img.unsigned(),
        Some(UnsignedView::U32(vec![0, 2_147_483_648, u32::MAX]))
    );
    let i8_img = image(
        ImageData::U8(vec![0, 128, 255]),
        Scaling {
            bscale: 1.0,
            bzero: -128.0,
            blank: None,
        },
    );
    assert_eq!(
        i8_img.unsigned(),
        Some(UnsignedView::I8(vec![-128, 0, 127]))
    );
}

#[test]
fn from_unsigned_constructors_invert_the_unsigned_view() {
    // from_uN builds the signed storage + BZERO offset; unsigned() recovers it.
    let u16s = vec![0u16, 1, 32768, 65535];
    let img = Image::from_u16(vec![4], &u16s);
    assert_eq!(img.samples, ImageData::I16(vec![-32768, -32767, 0, 32767]));
    assert_eq!(img.scaling.bzero, 32768.0);
    assert_eq!(img.unsigned(), Some(UnsignedView::U16(u16s)));

    let u64s = vec![0u64, 1u64 << 63, u64::MAX];
    assert_eq!(
        Image::from_u64(vec![3], &u64s).unsigned(),
        Some(UnsignedView::U64(u64s))
    );
    let i8s = vec![i8::MIN, 0, i8::MAX];
    assert_eq!(
        Image::from_i8(vec![3], &i8s).unsigned(),
        Some(UnsignedView::I8(i8s))
    );
}

#[test]
fn unsigned_u64_view_is_exact_where_physical_rounds() {
    // 2⁵³+1 is the smallest integer f64 cannot represent. The typed view recovers
    // it exactly; physical() (f64) rounds it to 2⁵³.
    let exact = 9_007_199_254_740_993u64; // 2⁵³ + 1
    let stored = (exact ^ 0x8000_0000_0000_0000) as i64;
    let img = image(
        ImageData::I64(vec![stored]),
        Scaling {
            bscale: 1.0,
            bzero: 9_223_372_036_854_775_808.0, // 2⁶³
            blank: None,
        },
    );
    assert_eq!(img.unsigned(), Some(UnsignedView::U64(vec![exact])));
    assert_eq!(img.physical()[0] as u64, exact - 1); // rounded to 2⁵³
}

#[test]
fn unsigned_returns_none_for_non_unsigned_scaling() {
    // Plain signed (BZERO=0) and a genuinely scaled image are not unsigned views.
    let signed = image(
        ImageData::I16(vec![1, 2, 3]),
        Scaling {
            bscale: 1.0,
            bzero: 0.0,
            blank: None,
        },
    );
    assert_eq!(signed.unsigned(), None);
    let scaled = image(
        ImageData::I16(vec![1, 2]),
        Scaling {
            bscale: 2.0,
            bzero: 32768.0,
            blank: None,
        },
    );
    assert_eq!(scaled.unsigned(), None); // BSCALE ≠ 1
}

#[test]
fn physical_realizes_unsigned_16_bit_via_the_bzero_offset() {
    // u16 trick: signed-16 storage with BSCALE=1, BZERO=32768.
    // -32768 -> 0, 0 -> 32768, 32767 -> 65535.
    let img = image(
        ImageData::I16(vec![-32768, 0, 32767]),
        Scaling {
            bscale: 1.0,
            bzero: 32768.0,
            blank: None,
        },
    );
    assert_eq!(img.physical(), vec![0.0, 32768.0, 65535.0]);
}

#[test]
fn float_physical_scales_and_passes_nan_through() {
    let img = image(
        ImageData::F32(vec![1.5, f32::NAN]),
        Scaling {
            bscale: 10.0,
            bzero: 1.0,
            blank: None,
        },
    );
    let phys = img.physical();
    assert_eq!(phys[0], 16.0); // 1 + 10·1.5
    assert!(phys[1].is_nan());
}

#[test]
fn sample_type_resolves_unsigned_and_signed_byte_conventions() {
    let s = |bscale: f64, bzero: f64| Scaling {
        bscale,
        bzero,
        blank: None,
    };

    // Plain signed BITPIX (no offset) keeps the stored signed type.
    assert_eq!(
        SampleType::from_scaling(Bitpix::I16, &s(1.0, 0.0)),
        SampleType::I16
    );
    assert_eq!(
        SampleType::from_scaling(Bitpix::I32, &s(1.0, 0.0)),
        SampleType::I32
    );
    assert_eq!(
        SampleType::from_scaling(Bitpix::I64, &s(1.0, 0.0)),
        SampleType::I64
    );

    // The unsigned convention: BSCALE=1 with BZERO the sign-bit offset 2^(n-1).
    assert_eq!(
        SampleType::from_scaling(Bitpix::I16, &s(1.0, 32_768.0)),
        SampleType::U16
    );
    assert_eq!(
        SampleType::from_scaling(Bitpix::I32, &s(1.0, 2_147_483_648.0)),
        SampleType::U32
    );
    assert_eq!(
        SampleType::from_scaling(Bitpix::I64, &s(1.0, 9_223_372_036_854_775_808.0)),
        SampleType::U64
    );

    // BITPIX=8 is unsigned by default; BZERO=-128 is the signed-byte convention.
    assert_eq!(
        SampleType::from_scaling(Bitpix::U8, &s(1.0, 0.0)),
        SampleType::U8
    );
    assert_eq!(
        SampleType::from_scaling(Bitpix::U8, &s(1.0, -128.0)),
        SampleType::I8
    );

    // Floats are unaffected by scaling.
    assert_eq!(
        SampleType::from_scaling(Bitpix::F32, &s(10.0, 1.0)),
        SampleType::F32
    );
    assert_eq!(
        SampleType::from_scaling(Bitpix::F64, &s(1.0, 0.0)),
        SampleType::F64
    );

    // A genuine BSCALE (≠ 1) at the offset BZERO is NOT the unsigned convention.
    assert_eq!(
        SampleType::from_scaling(Bitpix::I16, &s(2.0, 32_768.0)),
        SampleType::I16
    );

    // BLANK marks nulls within a type; it must not change the classification.
    let with_blank = Scaling {
        bscale: 1.0,
        bzero: 32_768.0,
        blank: Some(-1),
    };
    assert_eq!(
        SampleType::from_scaling(Bitpix::I16, &with_blank),
        SampleType::U16
    );
}

#[test]
fn sample_type_predicates_and_image_accessor() {
    assert!(SampleType::U16.is_unsigned());
    assert!(SampleType::U16.is_integer());
    assert!(!SampleType::U16.is_float());
    assert!(SampleType::I32.is_integer());
    assert!(!SampleType::I32.is_unsigned());
    assert!(SampleType::I8.is_integer());
    assert!(!SampleType::I8.is_unsigned());
    assert!(SampleType::F64.is_float());
    assert!(!SampleType::F64.is_integer());

    // Image::sample_type resolves the convention from its own scaling.
    let unsigned = image(
        ImageData::I16(vec![0, 1, 2]),
        Scaling {
            bscale: 1.0,
            bzero: 32_768.0,
            blank: None,
        },
    );
    assert_eq!(unsigned.sample_type(), SampleType::U16);
    let signed = image(
        ImageData::I16(vec![0, 1]),
        Scaling {
            bscale: 1.0,
            bzero: 0.0,
            blank: None,
        },
    );
    assert_eq!(signed.sample_type(), SampleType::I16);
}

#[test]
fn image_data_reports_its_bitpix() {
    assert_eq!(ImageData::U8(vec![]).bitpix(), Bitpix::U8);
    assert_eq!(ImageData::I16(vec![]).bitpix(), Bitpix::I16);
    assert_eq!(ImageData::I32(vec![]).bitpix(), Bitpix::I32);
    assert_eq!(ImageData::I64(vec![]).bitpix(), Bitpix::I64);
    assert_eq!(ImageData::F32(vec![]).bitpix(), Bitpix::F32);
    assert_eq!(ImageData::F64(vec![]).bitpix(), Bitpix::F64);
}

#[test]
fn scaling_defaults_to_the_identity_map() {
    let s = Scaling::from_header(&header(&["SIMPLE  = T"]));
    assert_eq!(
        s,
        Scaling {
            bscale: 1.0,
            bzero: 0.0,
            blank: None
        }
    );
    assert!(s.is_identity());
}

#[test]
fn scaling_reads_explicit_keywords() {
    let s = Scaling::from_header(&header(&[
        "BSCALE  = 2.5",
        "BZERO   = -1000.0",
        "BLANK   = -32768",
    ]));
    assert_eq!(
        s,
        Scaling {
            bscale: 2.5,
            bzero: -1000.0,
            blank: Some(-32768)
        }
    );
    assert!(!s.is_identity());
}

#[test]
fn unsigned_16_bit_offset_is_not_an_identity_map() {
    // The unsigned-u16 trick: BSCALE=1, BZERO=32768.
    let s = Scaling::from_header(&header(&["BSCALE  = 1", "BZERO   = 32768"]));
    assert_eq!(s.bzero, 32768.0);
    assert!(!s.is_identity());
}

#[cfg(feature = "ndarray")]
#[test]
fn ndarray_arrays_are_fortran_ordered() {
    // 2×3 image (NAXIS1 = 2, the fastest axis). Flat FITS buffer: (x, y) at x + 2·y.
    let img = Image {
        shape: vec![2, 3],
        samples: ImageData::I16(vec![0, 1, 10, 11, 20, 21]),
        scaling: Scaling {
            bscale: 2.0,
            bzero: 100.0,
            blank: None,
        },
    };
    // Typed, zero-copy array indexed in FITS order `[x, y]`.
    match img.clone().into_ndarray() {
        ImageArray::I16(arr) => {
            assert_eq!(arr.shape(), &[2, 3]);
            assert_eq!(arr[[1, 2]], 21); // x = 1 (NAXIS1), y = 2 (NAXIS2)
            assert_eq!(arr[[0, 1]], 10);
            // NumPy's `[y, x]` is a zero-copy stride swap.
            assert_eq!(arr.reversed_axes()[[2, 1]], 21);
        }
        other => panic!("expected I16 array, got {other:?}"),
    }
    // Physical plane: 100 + 2·sample.
    let phys = img.physical_array();
    assert_eq!(phys.shape(), &[2, 3]);
    assert_eq!(phys[[1, 2]], 100.0 + 2.0 * 21.0);
}