snarkvm_fields/traits/
square_root_field.rs

1// Copyright 2024-2025 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 crate::{Field, LegendreSymbol};
17
18/// The interface for a field that supports an efficient square-root operation.
19pub trait SquareRootField: Field {
20    /// Returns the Legendre symbol.
21    fn legendre(&self) -> LegendreSymbol;
22
23    /// Returns the square root of self, if it exists.
24    #[must_use]
25    fn sqrt(&self) -> Option<Self>;
26
27    /// Sets `self` to be the square root of `self`, if it exists.
28    fn sqrt_in_place(&mut self) -> Option<&mut Self>;
29}
snarkvm_fields/traits/square_root_field.rs

snarkvm_fields/traits/
square_root_field.rs
