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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
//! # Constrained Correlation Clustering
//!
//! Constrained correlation clustering encodings following \[1\].
//!
//! ## References
//!
//! - \[1\] Jeremias Berg and Matti Järvisalo: _Cost-optimal constrained
//! correlation clustering via weighted partial Maximum Satisfiability_, AIJ
//! 2017.

use std::{fmt, io};

use clap::ValueEnum;
use nom::{
    branch::alt,
    character::complete::{alphanumeric1, char, multispace1},
    combinator::{map, recognize},
    multi::many1,
    number::complete::double,
    sequence::{terminated, tuple},
};
use rustsat::{
    clause,
    instances::{fio::dimacs, ManageVars},
    types::{RsHashMap, Var},
    utils,
};

#[derive(Default, Copy, Clone, PartialEq, Eq, ValueEnum)]
pub enum Variant {
    Transitive,
    Unary,
    #[default]
    Binary,
}

impl fmt::Display for Variant {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Variant::Transitive => write!(f, "transitive"),
            Variant::Unary => write!(f, "unary"),
            Variant::Binary => write!(f, "binary"),
        }
    }
}

#[derive(PartialEq, Eq, Clone, Copy, Debug, Hash)]
enum VarId {
    /// b i k
    Binary(u32, u32),
    /// y i k
    Unary(u32, u32),
    /// EQ i j k
    Eq(u32, u32, u32),
    /// S i j
    Same(u32, u32),
}

#[derive(Debug, PartialEq, Eq, Clone)]
struct VarManager {
    next_var: Var,
    vars: RsHashMap<VarId, Var>,
}

impl VarManager {
    fn id(&mut self, id: VarId) -> Var {
        if let Some(var) = self.vars.get(&id) {
            return *var;
        }
        let var = self.new_var();
        self.vars.insert(id, var);
        var
    }
}

impl ManageVars for VarManager {
    fn new_var(&mut self) -> Var {
        let v = self.next_var;
        self.next_var += 1;
        v
    }

    fn max_var(&self) -> Option<Var> {
        if self.next_var == Var::new(0) {
            None
        } else {
            Some(self.next_var - 1)
        }
    }

    fn increase_next_free(&mut self, v: Var) -> bool {
        if v > self.next_var {
            self.next_var = v;
            return true;
        };
        false
    }

    fn combine(&mut self, other: Self) {
        if other.next_var > self.next_var {
            self.next_var = other.next_var;
        };
    }

    fn n_used(&self) -> u32 {
        self.next_var.idx32()
    }

    fn forget_from(&mut self, min_var: Var) {
        if min_var < self.next_var {
            self.vars.retain(|_, var| *var < min_var);
            self.next_var = min_var;
        }
    }
}

impl Default for VarManager {
    fn default() -> Self {
        Self {
            next_var: Var::new(0),
            vars: Default::default(),
        }
    }
}

#[derive(Clone, Copy, PartialEq, Eq, Debug)]
pub enum Similarity {
    Similar(usize),
    DisSimilar(usize),
    DontCare,
    MustLink,
    CannotLink,
}

enum Clause {
    /// EQUALITY i j k 0..3
    Eq(u32, u32, u32, u8),
    /// SameCluster i j 0..a
    Same(u32, u32, u32),
    /// ML i j 0..2a
    MustLink(u32, u32, u32),
    /// CL i j
    CannotLink(u32, u32),
    /// S i j
    Similar(u32, u32),
    /// -S i j
    DisSimilar(u32, u32),
}

pub struct Encoding {
    similarities: Vec<Similarity>,
    variant: Variant,
    n: u32,
    a: u32,
    var_manager: VarManager,
    next_clause: Clause,
}

impl Encoding {
    pub fn new<R: io::BufRead, Map: Fn(f64) -> Similarity>(
        in_reader: R,
        variant: Variant,
        sim_map: Map,
    ) -> anyhow::Result<Self> {
        if variant != Variant::Binary {
            panic!("only the binary encoding is implemented so far");
        }

        let mut ident_map = RsHashMap::default();
        let mut next_idx: u32 = 0;
        let process_line =
            |line: Result<String, io::Error>| -> Option<anyhow::Result<(String, String, f64)>> {
                let line = line.ok()?;
                let line = line.trim_start();
                if line.starts_with('%') {
                    return None;
                }
                let (_, tup) = tuple((
                    terminated(ident, multispace1),
                    terminated(ident, multispace1),
                    double,
                ))(line)
                .ok()?;
                if !ident_map.contains_key(&tup.0) {
                    ident_map.insert(tup.0.clone(), next_idx);
                    next_idx += 1;
                }
                if !ident_map.contains_key(&tup.1) {
                    ident_map.insert(tup.1.clone(), next_idx);
                    next_idx += 1;
                }
                Some(Ok(tup))
            };
        let pairwise = in_reader
            .lines()
            .filter_map(process_line)
            .collect::<Result<Vec<_>, _>>()?;
        let n = ident_map.len() as u32;

        let mut similarities = Vec::new();
        similarities.resize(Self::sim_idx(n - 2, n - 1, n) + 1, Similarity::DontCare);
        for (ident1, ident2, sim) in pairwise {
            let mut idx1 = *ident_map.get(&ident1).unwrap();
            let mut idx2 = *ident_map.get(&ident2).unwrap();
            if idx1 == idx2 {
                if sim_map(sim) != Similarity::MustLink {
                    eprintln!(
                        "warning: self-similarity for {} is {} (mapped to {:?})",
                        ident1,
                        sim,
                        sim_map(sim)
                    )
                }
                continue;
            }
            if idx2 < idx1 {
                std::mem::swap(&mut idx1, &mut idx2);
            }
            similarities[Self::sim_idx(idx1, idx2, n)] = sim_map(sim);
        }

        let a = utils::digits(ident_map.len(), 2);

        Ok(Self {
            similarities,
            variant,
            n,
            a,
            var_manager: Default::default(),
            next_clause: Clause::Eq(0, 1, 0, 0),
        })
    }

    /// Note: the the first index must be smaller than the second
    #[inline]
    fn sim_idx(idx1: u32, idx2: u32, n_idents: u32) -> usize {
        // indexing an upper triangular matrix compactly in a vec
        // https://stackoverflow.com/questions/27086195/linear-index-upper-triangular-matrix
        let idx1 = idx1 as usize;
        let idx2 = idx2 as usize;
        let n_idents = n_idents as usize;
        n_idents * (n_idents - 1) / 2 - (n_idents - idx1) * ((n_idents - idx1) - 1) / 2 + idx2
            - idx1
            - 1
    }
}

impl Iterator for Encoding {
    type Item = dimacs::McnfLine;

    fn next(&mut self) -> Option<Self::Item> {
        loop {
            match self.next_clause {
                Clause::Eq(idx1, idx2, k, cidx) => {
                    if idx1 >= self.n - 1 {
                        self.next_clause = Clause::Same(0, 1, 0);
                        continue;
                    }
                    if idx2 >= self.n {
                        self.next_clause = Clause::Eq(idx1 + 1, idx1 + 2, 0, 0);
                        continue;
                    }
                    if k >= self.a {
                        self.next_clause = Clause::Eq(idx1, idx2 + 1, 0, 0);
                        continue;
                    }
                    if cidx >= 4 {
                        self.next_clause = Clause::Eq(idx1, idx2, k + 1, 0);
                        continue;
                    }
                    if matches!(
                        self.similarities[Self::sim_idx(idx1, idx2, self.n)],
                        Similarity::DontCare | Similarity::MustLink
                    ) {
                        // Don't need equality vars for don't cares and must links
                        self.next_clause = Clause::Eq(idx1, idx2 + 1, 0, 0);
                        continue;
                    }
                    self.next_clause = Clause::Eq(idx1, idx2, k, cidx + 1);
                    let b1 = self.var_manager.id(VarId::Binary(idx1, k)).pos_lit();
                    let b2 = self.var_manager.id(VarId::Binary(idx2, k)).pos_lit();
                    let eql = self.var_manager.id(VarId::Eq(idx1, idx2, k)).pos_lit();
                    return Some(dimacs::McnfLine::Hard(match cidx {
                        0 => clause![eql, b1, b2],
                        1 => clause![eql, !b1, !b2],
                        2 => clause![!eql, !b1, b2],
                        3 => clause![!eql, b1, !b2],
                        _ => panic!(),
                    }));
                }
                Clause::Same(idx1, idx2, cidx) => {
                    if idx1 >= self.n - 1 {
                        self.next_clause = Clause::MustLink(0, 1, 0);
                        continue;
                    }
                    if idx2 >= self.n {
                        self.next_clause = Clause::Same(idx1 + 1, idx1 + 2, 0);
                        continue;
                    }
                    if cidx > self.a {
                        self.next_clause = Clause::Same(idx1, idx2 + 1, 0);
                        continue;
                    }
                    if matches!(
                        self.similarities[Self::sim_idx(idx1, idx2, self.n)],
                        Similarity::DontCare | Similarity::MustLink | Similarity::CannotLink
                    ) {
                        // Don't need same cluster vars for don't cares, must links, and cannot links
                        self.next_clause = Clause::Same(idx1, idx2 + 1, 0);
                        continue;
                    }
                    self.next_clause = Clause::Same(idx1, idx2, cidx + 1);
                    let sl = self.var_manager.id(VarId::Same(idx1, idx2)).pos_lit();
                    return Some(dimacs::McnfLine::Hard(match cidx {
                        cidx if cidx < self.a => {
                            let eql = self.var_manager.id(VarId::Eq(idx1, idx2, cidx)).pos_lit();
                            clause![!sl, eql]
                        }
                        _ => {
                            let mut cl: rustsat::types::constraints::Clause = (0..self.a)
                                .map(|k| self.var_manager.id(VarId::Eq(idx1, idx2, k)).neg_lit())
                                .collect();
                            cl.add(sl);
                            cl
                        }
                    }));
                }
                Clause::MustLink(idx1, idx2, cidx) => {
                    if idx1 >= self.n - 1 {
                        self.next_clause = Clause::CannotLink(0, 1);
                        continue;
                    }
                    if idx2 >= self.n {
                        self.next_clause = Clause::MustLink(idx1 + 1, idx1 + 2, 0);
                        continue;
                    }
                    if cidx >= 2 * self.a {
                        self.next_clause = Clause::MustLink(idx1, idx2 + 1, 0);
                        continue;
                    }
                    if !matches!(
                        self.similarities[Self::sim_idx(idx1, idx2, self.n)],
                        Similarity::MustLink
                    ) {
                        // Only need must link clauses for must links
                        self.next_clause = Clause::MustLink(idx1, idx2 + 1, 0);
                        continue;
                    }
                    self.next_clause = Clause::MustLink(idx1, idx2, cidx + 1);
                    let b1 = self.var_manager.id(VarId::Binary(idx1, cidx / 2)).pos_lit();
                    let b2 = self.var_manager.id(VarId::Binary(idx2, cidx / 2)).pos_lit();
                    return Some(dimacs::McnfLine::Hard(if cidx % 2 == 0 {
                        clause![!b1, b2]
                    } else {
                        clause![b1, !b2]
                    }));
                }
                Clause::CannotLink(idx1, idx2) => {
                    if idx1 >= self.n - 1 {
                        self.next_clause = Clause::Similar(0, 1);
                        continue;
                    }
                    if idx2 >= self.n {
                        self.next_clause = Clause::CannotLink(idx1 + 1, idx1 + 2);
                        continue;
                    }
                    if !matches!(
                        self.similarities[Self::sim_idx(idx1, idx2, self.n)],
                        Similarity::CannotLink
                    ) {
                        // Only need cannot link clauses for cannot links
                        self.next_clause = Clause::CannotLink(idx1, idx2 + 1);
                        continue;
                    }
                    self.next_clause = Clause::CannotLink(idx1, idx2 + 1);
                    return Some(dimacs::McnfLine::Hard(
                        (0..self.a)
                            .map(|k| self.var_manager.id(VarId::Eq(idx1, idx2, k)).neg_lit())
                            .collect(),
                    ));
                }
                Clause::Similar(idx1, idx2) => {
                    if idx1 >= self.n - 1 {
                        self.next_clause = Clause::DisSimilar(0, 1);
                        continue;
                    }
                    if idx2 >= self.n {
                        self.next_clause = Clause::Similar(idx1 + 1, idx1 + 2);
                        continue;
                    }
                    self.next_clause = Clause::Similar(idx1, idx2 + 1);
                    if let Similarity::Similar(weight) =
                        self.similarities[Self::sim_idx(idx1, idx2, self.n)]
                    {
                        return Some(dimacs::McnfLine::Soft(
                            clause![self.var_manager.id(VarId::Same(idx1, idx2)).pos_lit()],
                            weight,
                            0,
                        ));
                    }
                }
                Clause::DisSimilar(idx1, idx2) => {
                    if idx1 >= self.n - 1 {
                        return None;
                    }
                    if idx2 >= self.n {
                        self.next_clause = Clause::DisSimilar(idx1 + 1, idx1 + 2);
                        continue;
                    }
                    self.next_clause = Clause::DisSimilar(idx1, idx2 + 1);
                    if let Similarity::DisSimilar(weight) =
                        self.similarities[Self::sim_idx(idx1, idx2, self.n)]
                    {
                        return Some(dimacs::McnfLine::Soft(
                            clause![!self.var_manager.id(VarId::Same(idx1, idx2)).pos_lit()],
                            weight,
                            1,
                        ));
                    }
                }
            }
        }
    }
}

fn ident(input: &str) -> nom::IResult<&str, String> {
    map(
        recognize(many1(alt((alphanumeric1, recognize(char('_')))))),
        String::from,
    )(input)
}

pub fn scaling_map(sim: f64, multiplier: u32) -> isize {
    (sim * (multiplier as f64)).trunc() as isize
}

pub fn saturating_map(sim: isize, dont_care: usize, hard_thr: usize) -> Similarity {
    match sim.unsigned_abs() {
        asim if asim < dont_care => Similarity::DontCare,
        asim if asim > hard_thr => {
            if sim > 0 {
                Similarity::MustLink
            } else {
                Similarity::CannotLink
            }
        }
        _ => {
            if sim > 0 {
                Similarity::Similar(sim as usize)
            } else {
                Similarity::DisSimilar(-sim as usize)
            }
        }
    }
}