Skip to content

Commit 7801982

Browse files
committed
Fix docstrings
1 parent d8e0bc8 commit 7801982

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Sources/PrivateInformationRetrieval/IndexPir/IndexPirProtocol.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public enum PirKeyCompressionStrategy: String, CaseIterable, Codable, CodingKeyR
4444
public struct IndexPirConfig: Hashable, Codable, Sendable {
4545
/// Number of entries in the database.
4646
public var entryCount: Int
47-
/// Byte size of each entry in the database.
47+
/// Byte size of the largest entry in the database.
4848
public var entrySizeInBytes: Int
4949
/// Number of dimensions in the database.
5050
public let dimensionCount: Int
@@ -57,7 +57,7 @@ public struct IndexPirConfig: Hashable, Codable, Sendable {
5757
/// Whether to encode the entry size.
5858
public var encodingEntrySize: Bool
5959

60-
/// Size of the each entry in bytes after encoding.
60+
/// Size of the largest entry in bytes after encoding.
6161
public var encodedEntrySize: Int {
6262
if encodingEntrySize {
6363
// VarInt is monotonic, i.e. the largest entry will always have the largest encoded entry size.
@@ -71,7 +71,7 @@ public struct IndexPirConfig: Hashable, Codable, Sendable {
7171
/// Initializes an ``IndexPirConfig``.
7272
/// - Parameters:
7373
/// - entryCount: Number of entries in the database.
74-
/// - entrySizeInBytes: Byte size of each entry in the database.
74+
/// - entrySizeInBytes: Byte size of the largest entry in the database.
7575
/// - dimensionCount: Number of dimensions in database.
7676
/// - batchSize: Number of indices in a query to the database.
7777
/// - unevenDimensions: Whether or not to enable `uneven dimensions` optimization.
@@ -107,7 +107,7 @@ public struct IndexPirConfig: Hashable, Codable, Sendable {
107107
public struct IndexPirParameter: Hashable, Codable, Sendable {
108108
/// Number of entries in the database.
109109
public let entryCount: Int
110-
/// Byte size of each entry in the database, excluding any encoding of the entry size.
110+
/// Byte size of the largest entry in the database, excluding any encoding of the entry size.
111111
public let entrySizeInBytes: Int
112112
/// Number of plaintexts in each dimension of the database.
113113
public let dimensions: [Int]
@@ -137,7 +137,7 @@ public struct IndexPirParameter: Hashable, Codable, Sendable {
137137
/// Initializes an ``IndexPirParameter``.
138138
/// - Parameters:
139139
/// - entryCount: Number of entries in the database.
140-
/// - entrySizeInBytes: Byte size of each entry in the database, without encoding entry size.
140+
/// - entrySizeInBytes: Byte size of the largest entry in the database, without encoding entry size.
141141
/// - dimensions: Number of plaintexts in each dimension of the database.
142142
/// - batchSize: Number of indices in a query to the database.
143143
/// - evaluationKeyConfig: Evaluation key configuration.

0 commit comments

Comments
 (0)