💡

定数パラメータを制限する

に公開

Rust言語では型や関数に定数パラメーターを与えることができます。定数パラメーターはコンパイル時に評価されるため、コンパイラによる最適化の恩恵を受けることができます。定数パラメーターはその型が表現できる任意の値をとりますが、これに制限を加えることもできます。

対象読者

  • 定数パラメーターで受け取れる値を制限したい方
  • コンパイル時評価に興味がある方

ホワイトリスト方式

許可したい定数パラメーターが少数の場合、ホワイトリスト方式を使うことができます。許可したい値を列挙するだけなので、実装は容易です。また、stdのportable_simdでも採用されています。

次のプログラムはmod Pにおける乗法逆元を計算するプログラムで、Pが素数であることを前提としています。

/// クレートとして公開する場合にも、ユーザーは勝手に値を追加できないため有効(Orphan rule)
pub struct Prime<const P: u32>;
pub trait SupportedPrime {}

/// いくつかの素数を明示的に許可(ホワイトリスト)
/// 注意:数が多いとrust analyzerが悲鳴を上げる
macro_rules! supported_prime_impl {
    ($( $p:literal ),*) => {$(
        impl SupportedPrime for Prime<$p> {}
    )*};
}
supported_prime_impl!(2, 3, 5, 7, 11, 23, 998_244_353, 1_000_000_007);

/// 乗法逆元を計算
/// 不正なMODをコンパイル時に検出
pub fn mod_inv<const MOD: u32>(value: u32) -> u32
where
    Prime<MOD>: SupportedPrime
{
    todo!("value^(MOD-2)")
}

ルールベース

許可したい定数パラメーターが多い場合、ルールベースで制限することもできます。この手法は定数パラメーターを検証するconst fnを実装する必要があるため、複雑な問題に適用するのは難しいと思われます。また、関数呼び出しごとに評価が走るので、何度も呼び出すとrust analyzerに負担がかかります。

/// # Compile-time panic
///
/// Panics if `MOD` is NOT a prime number.
pub fn mod_inv<const MOD: u32>(value: u32) -> u32
{
    // const blockはコンパイル時評価を強制する方法で、書かなくても良いが、書いておくと安心
    // この部分はリリースビルドの最適化で消える(ゼロコスト)
    let _check = const {
        assert!(is_prime(MOD), "A prime number should be given as a constant parameter.")
    };
    todo!("value^(MOD-2)")
}

/// これが重いとrust analyzerが死ぬ
const fn is_prime(value: u32) -> bool {
    /// todo!()がconst文脈で評価されるため、デバッグビルドでもパニックする(const blockの副作用)
    /// Rust Playgroundなどで動かしてみる場合は、適当な値に変える必要がある
    todo!("検証コード")
}

Discussion