slatec 0.1.0

Safe Rust interface to selected SLATEC numerical routines
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

use slatec_sys::blas::level1 as raw;

use super::super::{BlasError, validation};
use super::audited_candidate_call;
use validation::{count, increment, input_pointer};

/// Returns the zero-based index of the first maximum-magnitude value.
pub fn idamax(x: &[f64]) -> Result<Option<usize>, BlasError> {
    idamax_strided(x.len(), x, 1)
}

/// Returns the zero-based index of the first maximum-magnitude strided value.
pub fn idamax_strided(n: usize, x: &[f64], incx: isize) -> Result<Option<usize>, BlasError> {
    let mut n_fortran = count(n, "n")?;
    let mut incx = increment(incx, "incx")?;
    let x = input_pointer(x, n, incx as isize, "x")?;
    if n == 0 {
        return Ok(None);
    }
    // Safety: `x` is read-only and storage-checked, and the raw arguments
    // conform to the validated ABI profile.
    let one_based = audited_candidate_call(|| unsafe { raw::idamax(&mut n_fortran, x, &mut incx) });
    let one_based = usize::try_from(one_based).map_err(|_| BlasError::NativeContractViolation {
        routine: "IDAMAX",
        detail: "returned a negative index",
    })?;
    if one_based == 0 || one_based > n {
        return Err(BlasError::NativeContractViolation {
            routine: "IDAMAX",
            detail: "returned an index outside the logical vector",
        });
    }
    Ok(Some(one_based - 1))
}