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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
//! [`Database`] into Protocol Buffers data.

use core::iter::IntoIterator;
use std::collections::BTreeSet;

use crate::error::Error;
use crate::io::{FileSystem, HashedFileOut};
use crate::kmeans::Codebook;
use crate::protos::database::{
    AttributesLog as ProtosAttributesLog,
    Database as ProtosDatabase,
    OperationSetAttribute as ProtosOperationSetAttribute,
    Partition as ProtosPartition,
    VectorSet as ProtosVectorSet,
};
use crate::partitions::Partitions;
use crate::protos::{Serialize, write_message};
use crate::vector::{BlockVectorSet, VectorSet};
use super::{Database, Partition};

/// Extension of a Protocol Buffers file.
pub const PROTOBUF_EXTENSION: &str = "binpb";

/// Serializes [`Database`].
pub fn serialize_database<'a, T, VS, FS>(
    db: &'a Database<T, VS>,
    fs: &mut FS,
) -> Result<(), Error>
where
    T: Clone,
    VS: VectorSet<T>,
    DatabaseSerialize<'a, T, VS>: Serialize<ProtosDatabase>,
    Partition<T>: Serialize<ProtosPartition>,
    BlockVectorSet<T>: Serialize<ProtosVectorSet>,
    FS: FileSystem,
{
    // serializes partitions
    let partition_ids = serialize_partitions(db.partitions(), fs)?;
    // serializes partition centroids
    let partition_centroids_id =
        serialize_partition_centroids(&db.partitions, fs)?;
    // serializes codebooks
    let codebook_ids = serialize_codebooks(&db.codebooks, fs)?;
    // sorts attribute names
    let attribute_names = get_sorted_attribute_names(&db);
    // serializes attributes
    let attributes_log_ids =
        serialize_attribute_table(&db, &partition_ids, &attribute_names, fs)?;
    // serializes the database
    let db = DatabaseSerialize {
        database: db,
        partition_ids,
        partition_centroids_id,
        codebook_ids,
        attributes_log_ids,
        attribute_names,
    };
    let db = db.serialize()?;
    let mut f = fs.create_compressed_hashed_file()?;
    write_message(&db, &mut f)?;
    f.persist(PROTOBUF_EXTENSION)?;
    Ok(())
}

// Serializes partitions.
fn serialize_partitions<I, T, FS>(
    partitions: I,
    fs: &mut FS,
) -> Result<Vec<String>, Error>
where
    I: IntoIterator<Item = Partition<T>>,
    T: Clone,
    Partition<T>: Serialize<ProtosPartition>,
    FS: FileSystem,
{
    let mut partition_ids: Vec<String> = Vec::new();
    for partition in partitions {
        let partition_id = serialize_partition(&partition, fs)?;
        partition_ids.push(partition_id);
    }
    Ok(partition_ids)
}

// Serializes a partition.
fn serialize_partition<T, FS>(
    partition: &Partition<T>,
    fs: &mut FS,
) -> Result<String, Error>
where
    T: Clone,
    Partition<T>: Serialize<ProtosPartition>,
    FS: FileSystem,
{
    let partition = partition.serialize()?;
    let mut f = fs.create_compressed_hashed_file_in("partitions")?;
    write_message(&partition, &mut f)?;
    f.persist(PROTOBUF_EXTENSION)
}

// Serializes the partition centroids.
fn serialize_partition_centroids<T, VS, FS>(
    partitions: &Partitions<T, VS>,
    fs: &FS,
) -> Result<String, Error>
where
    BlockVectorSet<T>: Serialize<ProtosVectorSet>,
    FS: FileSystem,
{
    let partition_centroids: ProtosVectorSet =
        partitions.codebook.centroids.serialize()?;
    let mut f = fs.create_hashed_file_in("partitions")?;
    write_message(&partition_centroids, &mut f)?;
    f.persist(PROTOBUF_EXTENSION)
}

// Serializes codebooks.
fn serialize_codebooks<T, FS>(
    codebooks: &Vec<Codebook<T>>,
    fs: &mut FS,
) -> Result<Vec<String>, Error>
where
    BlockVectorSet<T>: Serialize<ProtosVectorSet>,
    FS: FileSystem,
{
    let mut codebook_ids = Vec::with_capacity(codebooks.len());
    for codebook in codebooks {
        let codebook_id = serialize_codebook(codebook, fs)?;
        codebook_ids.push(codebook_id);
    }
    Ok(codebook_ids)
}

// Serializes a codebook.
fn serialize_codebook<T, FS>(
    codebook: &Codebook<T>,
    fs: &mut FS,
) -> Result<String, Error>
where
    BlockVectorSet<T>: Serialize<ProtosVectorSet>,
    FS: FileSystem,
{
    let codebook = codebook.centroids.serialize()?;
    let mut f = fs.create_hashed_file_in("codebooks")?;
    write_message(&codebook, &mut f)?;
    f.persist(PROTOBUF_EXTENSION)
}

// Obtains the sorted attribute names from a database.
fn get_sorted_attribute_names<T, VS>(db: &Database<T, VS>) -> Vec<String>
where
    VS: VectorSet<T>,
{
    let mut attribute_names: BTreeSet<String> = BTreeSet::new();
    for attributes in db.attribute_table.values() {
        attribute_names.extend(attributes.keys().cloned());
    }
    attribute_names.into_iter().collect()
}

// Serializes an attribute table.
//
// `attribute_names` must be sorted.
fn serialize_attribute_table<T, VS, FS>(
    db: &Database<T, VS>,
    partition_ids: &Vec<String>,
    attribute_names: &Vec<String>,
    fs: &mut FS,
) -> Result<Vec<String>, Error>
where
    VS: VectorSet<T>,
    FS: FileSystem,
{
    assert_eq!(db.num_partitions(), partition_ids.len());
    let mut attributes_log_ids: Vec<String> =
        Vec::with_capacity(db.num_partitions());
    for (pi, partition_id) in partition_ids.iter().enumerate() {
        let mut attributes_log = ProtosAttributesLog::new();
        attributes_log.partition_id = partition_id.clone();
        attributes_log.entries.reserve(db.vector_ids.len());
        for (_, id) in db.vector_ids
            .iter()
            .enumerate()
            .filter(|(vi, _)| db.partitions.codebook.indices[*vi] == pi)
        {
            if let Some(attributes) = db.attribute_table.get(id) {
                for (name, value) in attributes.iter() {
                    let mut set_attribute = ProtosOperationSetAttribute::new();
                    set_attribute.vector_id = Some(id.serialize()?).into();
                    set_attribute.name_index = attribute_names
                        .binary_search(name)
                        .or(Err(Error::InvalidContext(format!(
                            "attribute name must be encoded: {}",
                            name,
                        ))))? as u32;
                    set_attribute.value = Some(value.serialize()?).into();
                    attributes_log.entries.push(set_attribute);
                }
            }
        }
        let mut f = fs.create_compressed_hashed_file_in("attributes")?;
        write_message(&attributes_log, &mut f)?;
        attributes_log_ids.push(f.persist(PROTOBUF_EXTENSION)?);
    }
    Ok(attributes_log_ids)
}

/// Serializable form of [`Database`].
pub struct DatabaseSerialize<'a, T, VS>
where
    VS: VectorSet<T>,
{
    database: &'a Database<T, VS>,
    partition_ids: Vec<String>,
    partition_centroids_id: String,
    codebook_ids: Vec<String>,
    attributes_log_ids: Vec<String>,
    attribute_names: Vec<String>,
}

impl<'a, T, VS> core::ops::Deref for DatabaseSerialize<'a, T, VS>
where
    VS: VectorSet<T>,
{
    type Target = Database<T, VS>;

    fn deref(&self) -> &Self::Target {
        self.database
    }
}

impl<'a, VS> Serialize<ProtosDatabase> for DatabaseSerialize<'a, f32, VS>
where
    VS: VectorSet<f32>,
{
    fn serialize(&self) -> Result<ProtosDatabase, Error> {
        let mut db = ProtosDatabase::new();
        db.vector_size = self.vector_size() as u32;
        db.num_partitions = self.num_partitions() as u32;
        db.num_divisions = self.num_divisions() as u32;
        db.num_codes = self.num_clusters() as u32;
        db.partition_ids = self.partition_ids.clone();
        db.partition_centroids_id = self.partition_centroids_id.clone();
        db.codebook_ids = self.codebook_ids.clone();
        db.attributes_log_ids = self.attributes_log_ids.clone();
        db.attribute_names = self.attribute_names.clone();
        Ok(db)
    }
}

impl Serialize<ProtosPartition> for Partition<f32> {
    fn serialize(&self) -> Result<ProtosPartition, Error> {
        let mut partition = ProtosPartition::new();
        let m = self.vector_size();
        let d = self.num_divisions();
        partition.vector_size = m as u32;
        partition.num_divisions = d as u32;
        partition.centroid.reserve(m);
        partition.centroid.extend_from_slice(&self.centroid[..]);
        partition.vector_ids = self.vector_ids
            .iter()
            .map(|id| id.serialize())
            .collect::<Result<_, _>>()?;
        partition.encoded_vectors =
            Some(self.encoded_vectors.serialize()?).into();
        Ok(partition)
    }
}