Skip to content

Commit 3490edd

Browse files
authored
[docs] Decoder API clarification (#126)
Clarify the vector length requirements for the `decode` API. Signed-off-by: Ben Howe <[email protected]>
1 parent 43dcb61 commit 3490edd

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

libs/qec/include/cudaq/qec/decoder.h

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/****************************************************************-*- C++ -*-****
2-
* Copyright (c) 2024 NVIDIA Corporation & Affiliates. *
2+
* Copyright (c) 2024 - 2025 NVIDIA Corporation & Affiliates. *
33
* All rights reserved. *
44
* *
55
* This source code and the accompanying materials are made available under *
@@ -97,17 +97,15 @@ class decoder
9797
/// @brief Decode a single syndrome
9898
/// @param syndrome A vector of syndrome measurements where the floating point
9999
/// value is the probability that the syndrome measurement is a |1>. The
100-
/// length of the syndrome vector should be an integer multiple of the
101-
/// decoder's \p syndrome_size.
100+
/// length of the syndrome vector should be equal to \p syndrome_size.
102101
/// @returns Vector of length \p block_size with soft probabilities of errors
103102
/// in each index.
104103
virtual decoder_result decode(const std::vector<float_t> &syndrome) = 0;
105104

106105
/// @brief Decode a single syndrome
107106
/// @param syndrome An order-1 tensor of syndrome measurements where a 1 bit
108107
/// represents that the syndrome measurement is a |1>. The
109-
/// length of the syndrome vector should be an integer multiple of the
110-
/// decoder's \p syndrome_size.
108+
/// length of the syndrome vector should be equal to \p syndrome_size.
111109
/// @returns Vector of length \p block_size of errors in each index.
112110
virtual decoder_result decode(const cudaqx::tensor<uint8_t> &syndrome);
113111

0 commit comments

Comments
 (0)