snarkvm_fields/legendre.rs
1// Copyright 2024 Aleo Network Foundation
2// This file is part of the snarkVM library.
3
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at:
7
8// http://www.apache.org/licenses/LICENSE-2.0
9
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16use std::fmt::Debug;
17
18#[derive(Debug, PartialEq, Eq)]
19pub enum LegendreSymbol {
20 Zero = 0,
21 QuadraticResidue = 1,
22 QuadraticNonResidue = -1,
23}
24
25impl LegendreSymbol {
26 pub fn is_zero(&self) -> bool {
27 *self == LegendreSymbol::Zero
28 }
29
30 pub fn is_qnr(&self) -> bool {
31 *self == LegendreSymbol::QuadraticNonResidue
32 }
33
34 pub fn is_qr(&self) -> bool {
35 *self == LegendreSymbol::QuadraticResidue
36 }
37}