snarkvm_circuit_environment/traits/metrics.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::{Count, Mode};
17
18/// Trait for determining the number of constants, public input, private inputs, and constraints for an operation.
19pub trait Metrics<Op: ?Sized> {
20 type Case: ?Sized;
21
22 /// Returns the number of constants, public inputs, private inputs, and constraints.
23 fn count(parameter: &Self::Case) -> Count;
24}
25
26/// Trait for determining the mode of the output of an operation.
27pub trait OutputMode<Op: ?Sized> {
28 type Case: ?Sized;
29
30 /// Returns the mode of the output.
31 fn output_mode(input: &Self::Case) -> Mode;
32}