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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
//! Module with some basic collaborative filtering recommenders.
//! It would be nice to expand this module
use super::data::DataHandler;
use std::collections::HashMap;
use super::ID;


/// Trait that every recommender must satisfy.
pub trait Recommender {
    /// Predicts a rating given an user and an item.
    fn predict(&self, user: ID, item: ID) -> f64;
    /// Recommends items given an user. It must returns a vector of
    /// predicted ratings and item IDs sorted by rating
    fn recommend(&self, user_id: ID) -> Vec<(usize, f64)>;
}

/// An user based threshold neighbors recommender
pub struct BasicUserRecommender<'a, D: DataHandler + 'a> {
    data_handler: &'a mut D,
    threshold: f64,
    similarities: HashMap<(ID, ID), f64>,
    similarity: fn(&HashMap<ID, f64>, &HashMap<ID, f64>, usize) -> f64
}

impl<'a, D: DataHandler + 'a> BasicUserRecommender<'a, D> {
    /// Initializes a new recommender from a data handler, computes
    /// and stores the similarities between users
    pub fn new(data_handler: &mut D, threshold: f64, similarity: fn(&HashMap<ID, f64>, &HashMap<ID, f64>, usize) -> f64) -> BasicUserRecommender<D> {
        let mut similarities: HashMap<(ID, ID), f64> = HashMap::new();
        let user_ids = data_handler.get_user_ids();
        let n = data_handler.get_num_items();
        for user_id1 in &user_ids {
            for user_id2 in &user_ids {
                let user_1 = data_handler.get_user_ratings(*user_id1);
                let user_2 = data_handler.get_user_ratings(*user_id2);
                similarities.insert((*user_id1, *user_id2), similarity(&user_1, &user_2, n)); 
            }
        }
        BasicUserRecommender {
            data_handler: data_handler,
            threshold: threshold,
            similarities: similarities,
            similarity: similarity
        }
    }
    /// Adds an user to the data handler
    pub fn add_user(&mut self, user_id: ID) -> bool {
        self.data_handler.add_user(user_id)
    }
    /// Adds an item to the data handler
    pub fn add_item(&mut self, item_id: ID) -> bool {
        self.data_handler.add_item(item_id)
    }
    /// Adds a rating to the data handler, it computes the similarities for
    /// the user who added a new rating
    pub fn add_rating(&mut self, user_id: ID, item_id: ID, rating: f64) -> bool {
        let result = self.data_handler.add_rating(user_id, item_id, rating);
        if result {
            let user_ids = self.data_handler.get_user_ids();
            let user_1 = self.data_handler.get_user_ratings(user_id);
            let n = self.data_handler.get_num_items();
            for user_id2 in &user_ids {
                let user_2 = self. data_handler.get_user_ratings(*user_id2);
                self.similarities.insert((user_id, *user_id2), (self.similarity)(&user_1, &user_2, n)); 
            }
        }
        result
    }
}

impl<'a, D: DataHandler + 'a> Recommender for BasicUserRecommender<'a, D> {
    /// Predicts the rating for an user and item averaging the ratings of the
    /// users whose similarities with the user are above the threshold.
    /// If there are no users above the threshold it returns -1.0
    fn predict(&self, user_id: ID, item_id: ID) -> f64 {
        let item = self.data_handler.get_item_ratings(item_id);
        let mut total_sim: f64 = 0.0;
        let mut total_rat: f64 = 0.0;
        for (other_id, rating) in item {
            let sim = *self.similarities.get(&(user_id, other_id)).unwrap();
            if sim > self.threshold {
                total_sim += sim;
                total_rat += rating*sim;
            }
        }
        if total_sim > 0.0 {
            return total_rat/total_sim;
        }
        -1.0
    }
    /// Generates a sorted vector of item IDs by a predicted rating which is
    /// computed in the same way that the predict method. It ignores items
    /// that have a predicted rating of -1.0
    fn recommend(&self, user_id: ID) -> Vec<(ID, f64)>{
        let items = self.data_handler.get_item_ids();
        let mut recom: Vec<(ID, f64)> = Vec::new();
        for item_id in items {
            let item = self.data_handler.get_item_ratings(item_id);
            let mut total_sim: f64 = 0.0;
            let mut total_rat: f64 = 0.0;
            for (other_id, rating) in item {
                let sim = *self.similarities.get(&(user_id, other_id)).unwrap();
                if sim > self.threshold {
                    total_sim += sim;
                    total_rat += rating*sim;
                }
            }
            if total_sim > 0.0 {
                recom.push((item_id, total_rat/total_sim));
            }
        }
        recom.sort_by(|&(id_1, _), &(id_2, _)| id_2.partial_cmp(&id_1).unwrap());
        recom
    }
}

/// An item based threshold neighbors recommender
pub struct BasicItemRecommender<'a, D: DataHandler + 'a> {
    data_handler: &'a mut D,
    threshold: f64,
    similarities: HashMap<(ID, ID), f64>,
    similarity: fn(&HashMap<ID, f64>, &HashMap<ID, f64>, usize) -> f64
}

impl<'a, D: DataHandler + 'a> BasicItemRecommender<'a, D> {
    /// Initializes a new recommender from a data handler, computes
    /// and stores the similarities between items
    pub fn new(data_handler: &mut D, threshold: f64, similarity: fn(&HashMap<usize, f64>, &HashMap<usize, f64>, usize) -> f64) -> BasicItemRecommender<D> {
        let mut similarities: HashMap<(ID, ID), f64> = HashMap::new();
        let item_ids = data_handler.get_item_ids();
        let n = data_handler.get_num_users();
        for item_id1 in &item_ids {
            for item_id2 in &item_ids {
                let item_1 = data_handler.get_item_ratings(*item_id1);
                let item_2 = data_handler.get_item_ratings(*item_id2);
                similarities.insert((*item_id1, *item_id2), similarity(&item_1, &item_2, n)); 
            }
        }
        BasicItemRecommender {
            data_handler: data_handler,
            threshold: threshold,
            similarities: similarities,
            similarity: similarity
        }
    }
    /// Adds an user to the data handler
    pub fn add_user(&mut self, user_id: ID) -> bool {
        self.data_handler.add_user(user_id)
    }
    /// Adds an item to the data handler
    pub fn add_item(&mut self, item_id: ID) -> bool {
        self.data_handler.add_item(item_id)
    }
    /// Adds a rating to the data handler, it computes the similarities for
    /// the item which had a new rating
    pub fn add_rating(&mut self, user_id: ID, item_id: ID, rating: f64) -> bool {
        let result = self.data_handler.add_rating(user_id, item_id, rating);
        if result {
            let item_ids = self.data_handler.get_item_ids();
            let item_1 = self.data_handler.get_item_ratings(item_id);
            let n = self.data_handler.get_num_users();
            for item_id2 in &item_ids {
                let item_2 = self. data_handler.get_item_ratings(*item_id2);
                self.similarities.insert((item_id, *item_id2), (self.similarity)(&item_1, &item_2, n)); 
            }
        }
        result
    }
}

impl<'a, D: DataHandler + 'a> Recommender for BasicItemRecommender<'a, D> {
    /// Predicts the rating for an user and item averaging the ratings of the
    /// items whose similarities with the item are above the threshold.
    /// If there are no item above the threshold it returns -1.0
    fn predict(&self, user_id: ID, item_id: ID) -> f64 {
        let user = self.data_handler.get_user_ratings(user_id);
        let mut total_sim: f64 = 0.0;
        let mut total_rat: f64 = 0.0;
        for (other_id, rating) in user {
            let sim = *self.similarities.get(&(item_id, other_id)).unwrap();
            if sim > self.threshold {
                total_sim += sim;
                total_rat += rating*sim;
            }
        }
        if total_sim > 0.0 {
            return total_rat/total_sim;
        }
        0.0
    }
    /// Generates a sorted vector of item IDs by a predicted rating which is
    /// computed in the same way that the predict method. It ignores items
    /// that have a predicted rating of -1.0
    fn recommend(&self, user_id: ID) -> Vec<(ID, f64)>{
        let user = self.data_handler.get_user_ratings(user_id);
        let items = self.data_handler.get_item_ids();
        let mut recom: Vec<(ID, f64)> = Vec::new();
        for item_id in items {
            let mut total_sim: f64 = 0.0;
            let mut total_rat: f64 = 0.0;
            for (other_id, rating) in &user {
                let sim = *self.similarities.get(&(item_id, *other_id)).unwrap();
                if sim > self.threshold {
                    total_sim += sim;
                    total_rat += rating*sim;
                }
            }
            if total_sim > 0.0 {
                recom.push((item_id, total_rat/total_sim));
            }
        }
        recom.sort_by(|&(id_1, _), &(id_2, _)| id_2.partial_cmp(&id_1).unwrap());
        recom
    }
}

/// An user based nearest neighbors recommender
pub struct KNNUserRecommender<'a, D: DataHandler + 'a> {
    data_handler: &'a mut D,
    k: usize,
    similarities: HashMap<(ID, ID), f64>,
    similarity: fn(&HashMap<ID, f64>, &HashMap<ID, f64>, usize) -> f64
}

impl<'a, D: DataHandler + 'a> KNNUserRecommender<'a, D> {
    /// Initializes a new recommender from a data handler, computes
    /// and stores the similarities between users
    pub fn new(data_handler: &mut D, k: usize, similarity: fn(&HashMap<ID, f64>, &HashMap<ID, f64>, usize) -> f64) -> KNNUserRecommender<D> {
        let mut similarities: HashMap<(ID, ID), f64> = HashMap::new();
        let user_ids = data_handler.get_user_ids();
        let n = data_handler.get_num_items();
        for user_id1 in &user_ids {
            for user_id2 in &user_ids {
                let user_1 = data_handler.get_user_ratings(*user_id1);
                let user_2 = data_handler.get_user_ratings(*user_id2);
                similarities.insert((*user_id1, *user_id2), similarity(&user_1, &user_2, n)); 
            }
        }
        KNNUserRecommender {
            data_handler: data_handler,
            k: k,
            similarities: similarities,
            similarity: similarity
        }
    }
    /// Adds an user to the data handler
    pub fn add_user(&mut self, user_id: ID) -> bool {
        self.data_handler.add_user(user_id)
    }
    /// Adds an item to the data handler
    pub fn add_item(&mut self, item_id: ID) -> bool {
        self.data_handler.add_item(item_id)
    }
    /// Adds a rating to the data handler, it computes the similarities for
    /// the user who added a new rating
    pub fn add_rating(&mut self, user_id: ID, item_id: ID, rating: f64) -> bool {
        let result = self.data_handler.add_rating(user_id, item_id, rating);
        if result {
            let user_ids = self.data_handler.get_user_ids();
            let user_1 = self.data_handler.get_user_ratings(user_id);
            let n = self.data_handler.get_num_items();
            for user_id2 in &user_ids {
                let user_2 = self. data_handler.get_user_ratings(*user_id2);
                self.similarities.insert((user_id, *user_id2), (self.similarity)(&user_1, &user_2, n)); 
            }
        }
        result
    }
}

impl<'a, D: DataHandler + 'a> Recommender for KNNUserRecommender<'a, D> {
    /// Predicts the rating for an user and item averaging the ratings of the
    /// k users most similar to the user rating the item.
    fn predict(&self, user_id: ID, item_id: ID) -> f64 {
        let mut total_sim: f64 = 0.0;
        let mut total_rat: f64 = 0.0;
        let mut ratings: Vec<(f64, f64)> = self.data_handler.get_item_ratings(item_id)
            .into_iter()
            .map(|(other_id, rating)| {
                let sim = *self.similarities.get(&(user_id, other_id)).unwrap();
                (sim, rating)
            })
            .collect();
        ratings.sort_by(|&(_,r_1), &(_, r_2)| r_2.partial_cmp(&r_1).unwrap());
        ratings.truncate(self.k);
        for (sim, rating) in ratings {
            total_sim += sim;
            total_rat += rating*sim;
        }
        if total_sim > 0.0 {
            return total_rat/total_sim;
        }
        -1.0
    }
    /// Generates a sorted vector of item IDs by a predicted rating which is
    /// computed in the same way that the predict method. It ignores items
    /// that have a predicted rating of -1.0
    fn recommend(&self, user_id: ID) -> Vec<(ID, f64)>{
        let items = self.data_handler.get_item_ids();
        let mut recom: Vec<(ID, f64)> = Vec::new();
        for item_id in items {
            let mut total_sim: f64 = 0.0;
            let mut total_rat: f64 = 0.0;
            let mut ratings: Vec<(f64, f64)> = self.data_handler.get_item_ratings(item_id)
                .into_iter()
                .map(|(other_id, rating)| {
                    let sim = *self.similarities.get(&(user_id, other_id)).unwrap();
                    (sim, rating)
                })
                .collect();
            ratings.sort_by(|&(_,r_1), &(_, r_2)| r_2.partial_cmp(&r_1).unwrap());
            ratings.truncate(self.k);
            for (sim, rating) in ratings {
                total_sim += sim;
                total_rat += rating*sim;
            }
            if total_sim > 0.0 {
                recom.push((item_id, total_rat/total_sim));
            }
        }
        recom.sort_by(|&(id_1, _), &(id_2, _)| id_2.partial_cmp(&id_1).unwrap());
        recom
    }
}

/// An item based nearest neighbors recommender
pub struct KNNItemRecommender<'a, D: DataHandler + 'a> {
    data_handler: &'a mut D,
    k: usize,
    similarities: HashMap<(ID, ID), f64>,
    similarity: fn(&HashMap<ID, f64>, &HashMap<ID, f64>, usize) -> f64
}

impl<'a, D: DataHandler + 'a> KNNItemRecommender<'a, D> {
    /// Initializes a new recommender from a data handler, computes
    /// and stores the similarities between items
    pub fn new(data_handler: &mut D, k: usize, similarity: fn(&HashMap<usize, f64>, &HashMap<usize, f64>, usize) -> f64) -> KNNItemRecommender<D> {
        let mut similarities: HashMap<(ID, ID), f64> = HashMap::new();
        let item_ids = data_handler.get_item_ids();
        let n = data_handler.get_num_users();
        for item_id1 in &item_ids {
            for item_id2 in &item_ids {
                let item_1 = data_handler.get_item_ratings(*item_id1);
                let item_2 = data_handler.get_item_ratings(*item_id2);
                similarities.insert((*item_id1, *item_id2), similarity(&item_1, &item_2, n)); 
            }
        }
        KNNItemRecommender {
            data_handler: data_handler,
            k: k,
            similarities: similarities,
            similarity: similarity
        }
    }
    /// Adds an user to the data handler
    pub fn add_user(&mut self, user_id: ID) -> bool {
        self.data_handler.add_user(user_id)
    }
    /// Adds an item to the data handler
    pub fn add_item(&mut self, item_id: ID) -> bool {
        self.data_handler.add_item(item_id)
    }
    /// Adds a rating to the data handler, it computes the similarities for
    /// the item which had a new rating
    pub fn add_rating(&mut self, user_id: ID, item_id: ID, rating: f64) -> bool {
        let result = self.data_handler.add_rating(user_id, item_id, rating);
        if result {
            let item_ids = self.data_handler.get_item_ids();
            let item_1 = self.data_handler.get_item_ratings(item_id);
            let n = self.data_handler.get_num_users();
            for item_id2 in &item_ids {
                let item_2 = self. data_handler.get_item_ratings(*item_id2);
                self.similarities.insert((item_id, *item_id2), (self.similarity)(&item_1, &item_2, n)); 
            }
        }
        result
    }
}

impl<'a, D: DataHandler + 'a> Recommender for KNNItemRecommender<'a, D> {
    
    fn predict(&self, user_id: ID, item_id: ID) -> f64 {
        /// Predicts the rating for an user and item averaging the ratings of the
        /// k items most similar to the item rated by the user.
        let mut total_sim: f64 = 0.0;
        let mut total_rat: f64 = 0.0;
        let mut ratings: Vec<(f64, f64)> = self.data_handler.get_user_ratings(user_id)
            .into_iter()
            .map(|(other_id, rating)| {
                let sim = *self.similarities.get(&(item_id, other_id)).unwrap();
                (sim, rating)
            })
            .collect();
        ratings.sort_by(|&(_,r_1), &(_, r_2)| r_2.partial_cmp(&r_1).unwrap());
        ratings.truncate(self.k);
        for (sim, rating) in ratings {
            total_sim += sim;
            total_rat += rating*sim;
        }
        if total_sim > 0.0 {
            return total_rat/total_sim;
        }
        0.0
    }
    /// Generates a sorted vector of item IDs by a predicted rating which is
    /// computed in the same way that the predict method. It ignores items
    /// that have a predicted rating of -1.0    
    fn recommend(&self, user_id: ID) -> Vec<(ID, f64)>{
        let user = self.data_handler.get_user_ratings(user_id);
        let items = self.data_handler.get_item_ids();
        let mut recom: Vec<(ID, f64)> = Vec::new();
        for item_id in items {
            let mut total_sim: f64 = 0.0;
            let mut total_rat: f64 = 0.0;
            let mut ratings: Vec<(f64, f64)> = user.iter()
            .map(|(other_id, rating)| {
                let sim = *self.similarities.get(&(item_id, *other_id)).unwrap();
                (sim, *rating)
            })
            .collect();
            ratings.sort_by(|&(_,r_1), &(_, r_2)| r_2.partial_cmp(&r_1).unwrap());
            ratings.truncate(self.k);
            for (sim, rating) in ratings {
                total_sim += sim;
                total_rat += rating*sim;
            }
            if total_sim > 0.0 {
                recom.push((item_id, total_rat/total_sim));
            }
        }
        recom.sort_by(|&(id_1, _), &(id_2, _)| id_2.partial_cmp(&id_1).unwrap());
        recom
    }
}