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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

// Copyright (C) 2019-2023 Aleo Systems Inc.
// This file is part of the snarkVM library.

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
// http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![cfg_attr(test, allow(clippy::assertions_on_result_states))]
#![warn(clippy::cast_possible_truncation)]

mod arithmetic;
mod bitwise;
mod bytes;
mod compare;
mod from_bits;
mod from_field;
mod from_field_lossy;
mod one;
mod parse;
mod random;
mod serialize;
mod size_in_bits;
mod size_in_bytes;
mod to_bits;
mod to_field;
mod zero;

pub use snarkvm_console_network_environment::prelude::*;
pub use snarkvm_console_types_boolean::Boolean;
pub use snarkvm_console_types_field::Field;

#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub struct Scalar<E: Environment> {
    /// The underlying scalar element.
    scalar: E::Scalar,
}

impl<E: Environment> ScalarTrait for Scalar<E> {}

impl<E: Environment> Scalar<E> {
    /// The scalar size in bits.
    pub const SIZE_IN_BITS: usize = E::Scalar::SIZE_IN_BITS;
    /// The scalar size in bytes.
    pub const SIZE_IN_BYTES: usize = (E::Scalar::SIZE_IN_BITS + 7) / 8;
    /// The scalar capacity for data bits.
    pub const SIZE_IN_DATA_BITS: usize = E::Scalar::SIZE_IN_DATA_BITS;

    /// Initializes a new scalar.
    pub const fn new(scalar: E::Scalar) -> Self {
        Self { scalar }
    }
}

impl<E: Environment> TypeName for Scalar<E> {
    /// Returns the type name as a string.
    #[inline]
    fn type_name() -> &'static str {
        "scalar"
    }
}

impl<E: Environment> Deref for Scalar<E> {
    type Target = E::Scalar;

    #[inline]
    fn deref(&self) -> &Self::Target {
        &self.scalar
    }
}