coopgame 0.2.0

TU協力ゲームの仁・プレ仁・カーネル・プレカーネルの計算と検証
Documentation
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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
//! 提携ごとの値の読み書き (JSON・CSV) と、一部の提携だけ値が分かるゲーム。
//!
//! プレイヤーは 0 始まりの番号で書く。
//!
//! # JSON
//!
//! ```json
//! {
//!   "players": 3,
//!   "type": "value",
//!   "values": {"0": 0, "1": 0, "2": 0, "0,1": 4, "0,2": 3, "1,2": 2, "0,1,2": 6}
//! }
//! ```
//!
//! - `type` は `"value"` (既定、提携の価値) か `"cost"` (提携の費用)。
//! - `values` のキーは提携のメンバーの番号をカンマでつないだもの (順序と空白は問わない)。
//!   `[{"coalition": [0, 1], "value": 4}, ...]` の配列でもよい。
//! - `players` (人数) を省くと、現れた最大の番号 + 1 人とする。
//!
//! # CSV
//!
//! 1 行目は見出し `coalition,value`。提携のメンバーの番号は `|` でつなぐ (例: `0|1,4`)。
//! 費用ゲームは見出しを `coalition,cost` にする。人数は現れた最大の番号 + 1。
//!
//! # 値が分からない提携
//!
//! 全ての提携の値を見積もれないことは多い。[`Missing`] で扱いを選ぶ。
//!
//! - [`Missing::Error`]: 分からない提携があればエラーにして一覧を示す (既定)。
//! - [`Missing::Zero`]: 分からない提携の値を 0 とみなす。
//! - 値が分かる提携だけで解く: [`GameData::partial`] で [`PartialGame`] を作り、オラクル版の仁に渡す。
//!   結果は「値が分かる提携の超過だけを辞書式に最小化した配分」で、真のゲームの仁とは限らない。

use std::collections::HashMap;

use serde_json::Value;

use crate::Domain;
use crate::error::{Error, Result};
use crate::game::oracle::OracleGame;
use crate::game::{Coalition, ExplicitGame, MAX_PLAYERS, PlayerSet, SetFunction};
use crate::nucleolus::NucleolusResult;
use crate::solution::Guarantee;

/// 値の種類。
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum Kind {
    /// 提携の価値 (大きいほどよい)。
    Value,
    /// 提携の費用 (小さいほどよい)。[`crate::games::cost::CostGame`] で扱う。
    Cost,
}

impl Kind {
    /// JSON の `type` と CSV の見出しでの名前 (`"value"`・`"cost"`)。
    pub fn as_str(self) -> &'static str {
        match self {
            Kind::Value => "value",
            Kind::Cost => "cost",
        }
    }

    pub fn parse(text: &str) -> Option<Kind> {
        match text {
            "value" => Some(Kind::Value),
            "cost" => Some(Kind::Cost),
            _ => None,
        }
    }
}

/// 値が分からない提携の扱い。
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum Missing {
    Error,
    Zero,
}

/// 読み込んだゲーム。
#[derive(Clone, Debug, PartialEq)]
pub struct GameData {
    pub players: usize,
    pub kind: Kind,
    /// 値が分かる提携 (空でない) と値。
    pub known: Vec<(Coalition, f64)>,
}

fn parse_error(message: impl Into<String>) -> Error {
    Error::Parse {
        line: 0,
        message: message.into(),
    }
}

/// プレイヤーの番号を読む。
fn player(text: &str) -> Result<usize> {
    let text = text.trim();
    text.parse()
        .map_err(|_| parse_error(format!("プレイヤーの番号 (0 以上の整数) でない: {text:?}")))
}

fn build(players: Option<usize>, kind: Kind, entries: Vec<(Vec<usize>, f64)>) -> Result<GameData> {
    let highest = entries.iter().flat_map(|(members, _)| members).max();
    let n = match (players, highest) {
        (Some(n), Some(&i)) if i >= n => {
            return Err(parse_error(format!("プレイヤー番号 {i} が人数 {n} 以上")));
        }
        (Some(n), _) => n,
        (None, Some(&i)) => i + 1,
        (None, None) => 0,
    };
    if n == 0 {
        return Err(parse_error("プレイヤーがいない"));
    }
    if n > 63 {
        return Err(Error::TooManyPlayers {
            players: n,
            max: 63,
        });
    }
    let mut known: HashMap<u64, f64> = HashMap::new();
    for (members, value) in entries {
        if members.is_empty() {
            return Err(parse_error("空の提携の値は指定しない (常に 0)"));
        }
        if !value.is_finite() {
            return Err(parse_error("値が有限の数でない"));
        }
        let coalition = Coalition::from_players(&members);
        if known.insert(coalition.0, value).is_some() {
            return Err(parse_error(format!("提携 {coalition} の値が重複している")));
        }
    }
    let mut known: Vec<(Coalition, f64)> = known
        .into_iter()
        .map(|(mask, v)| (Coalition(mask), v))
        .collect();
    known.sort_by_key(|(c, _)| c.0);
    let grand = Coalition::grand(n).0;
    if !known.iter().any(|(c, _)| c.0 == grand) {
        return Err(parse_error("全体提携の値がない"));
    }
    Ok(GameData {
        players: n,
        kind,
        known,
    })
}

/// JSON のテキストを読む。
pub fn parse_json(text: &str) -> Result<GameData> {
    let root: Value =
        serde_json::from_str(text).map_err(|e| parse_error(format!("JSON として読めない: {e}")))?;
    let kind = match root.get("type").and_then(Value::as_str) {
        None => Kind::Value,
        Some(text) => Kind::parse(text)
            .ok_or_else(|| parse_error(format!("type は \"value\" か \"cost\": {text:?}")))?,
    };
    let players = match root.get("players") {
        None => None,
        Some(v) => Some(
            v.as_u64()
                .ok_or_else(|| parse_error("players は人数 (0 以上の整数)"))? as usize,
        ),
    };
    let number = |v: &Value| v.as_f64().ok_or_else(|| parse_error("値は数"));
    let mut entries = Vec::new();
    match root.get("values") {
        Some(Value::Object(map)) => {
            for (key, value) in map {
                let members = key.split(',').map(player).collect::<Result<_>>()?;
                entries.push((members, number(value)?));
            }
        }
        Some(Value::Array(list)) => {
            for item in list {
                let members = item
                    .get("coalition")
                    .and_then(Value::as_array)
                    .ok_or_else(|| parse_error("各要素に coalition (番号の配列) が必要"))?;
                let members: Vec<usize> = members
                    .iter()
                    .map(|m| {
                        m.as_u64()
                            .map(|i| i as usize)
                            .ok_or_else(|| parse_error("coalition は番号 (0 以上の整数) の配列"))
                    })
                    .collect::<Result<_>>()?;
                let value = item
                    .get("value")
                    .ok_or_else(|| parse_error("各要素に value が必要"))?;
                entries.push((members, number(value)?));
            }
        }
        _ => return Err(parse_error("values (オブジェクトか配列) が必要")),
    }
    build(players, kind, entries)
}

/// CSV のテキストを読む (見出し `coalition,value` か `coalition,cost`)。
pub fn parse_csv(text: &str) -> Result<GameData> {
    let mut lines = text
        .lines()
        .enumerate()
        .map(|(i, l)| (i + 1, l.trim()))
        .filter(|(_, l)| !l.is_empty() && !l.starts_with('#'));
    let (_, header) = lines.next().ok_or_else(|| parse_error("空の CSV"))?;
    let header = header.replace(' ', "");
    let kind = header
        .strip_prefix("coalition,")
        .and_then(Kind::parse)
        .ok_or_else(|| {
            parse_error(format!(
                "見出しは coalition,value か coalition,cost: {header:?}"
            ))
        })?;
    let mut entries = Vec::new();
    for (line, row) in lines {
        let (coalition, value) = row.rsplit_once(',').ok_or(Error::Parse {
            line,
            message: "提携,値 の形でない".into(),
        })?;
        let value: f64 = value.trim().parse().map_err(|_| Error::Parse {
            line,
            message: format!("値として読めない: {value:?}"),
        })?;
        let members = coalition
            .split('|')
            .map(player)
            .collect::<Result<_>>()
            .map_err(|e| Error::Parse {
                line,
                message: e.to_string(),
            })?;
        entries.push((members, value));
    }
    build(None, kind, entries)
}

/// 拡張子 (`.json` か `.csv`) で形式を選んで読む。
pub fn parse_by_extension(path: &str, text: &str) -> Result<GameData> {
    if path.ends_with(".json") {
        parse_json(text)
    } else if path.ends_with(".csv") {
        parse_csv(text)
    } else {
        Err(Error::InvalidArgument(format!(
            "{path}: 拡張子が .json でも .csv でもない"
        )))
    }
}

impl GameData {
    /// 値が分からない (空でない) 提携。
    pub fn missing(&self) -> Vec<Coalition> {
        let n = self.players;
        if n > MAX_PLAYERS {
            return Vec::new();
        }
        let known: std::collections::HashSet<u64> = self.known.iter().map(|(c, _)| c.0).collect();
        (1u64..(1 << n))
            .filter(|mask| !known.contains(mask))
            .map(Coalition)
            .collect()
    }

    /// 全提携の値の表にする。
    pub fn to_explicit(&self, missing: Missing) -> Result<ExplicitGame> {
        let n = self.players;
        if n > MAX_PLAYERS {
            return Err(Error::TooManyPlayers {
                players: n,
                max: MAX_PLAYERS,
            });
        }
        let absent = self.missing();
        if missing == Missing::Error && !absent.is_empty() {
            let listed: Vec<String> = absent.iter().take(10).map(Coalition::to_string).collect();
            return Err(Error::InvalidArgument(format!(
                "値が分からない提携が {} 個ある: {}{} (0 とみなすか、分かる提携だけで解く)",
                absent.len(),
                listed.join(" "),
                if absent.len() > 10 { " ..." } else { "" }
            )));
        }
        let mut values = vec![0.0; (1usize << n) - 1];
        for (coalition, value) in &self.known {
            values[coalition.index() - 1] = *value;
        }
        ExplicitGame::from_binary(&values)
    }

    /// 値が分かる提携だけを持つゲーム (価値のゲームに限る。費用なら節約ゲームに直してから使う)。
    pub fn partial(&self) -> Result<PartialGame> {
        if self.kind != Kind::Value {
            return Err(Error::InvalidArgument(
                "値が分かる提携だけで解くのは価値のゲーム (type = value) に限る".into(),
            ));
        }
        let n = self.players;
        let known: HashMap<PlayerSet, f64> = self
            .known
            .iter()
            .map(|(c, v)| (PlayerSet::from_coalition(n, *c), *v))
            .collect();
        Ok(PartialGame { players: n, known })
    }

    /// JSON に書く (値の種類と、値が分かる全ての提携)。
    pub fn to_json(&self) -> String {
        let values: serde_json::Map<String, Value> = self
            .known
            .iter()
            .map(|(c, v)| {
                let key = c
                    .members()
                    .map(|i| i.to_string())
                    .collect::<Vec<_>>()
                    .join(",");
                (key, Value::from(*v))
            })
            .collect();
        let root = serde_json::json!({
            "players": self.players,
            "type": self.kind.as_str(),
            "values": values,
        });
        serde_json::to_string_pretty(&root).expect("JSON に書ける")
    }
}

/// 値が分かる提携だけを持つゲーム。分からない提携の値は NaN を返す。
#[derive(Clone, Debug, PartialEq)]
pub struct PartialGame {
    players: usize,
    known: HashMap<PlayerSet, f64>,
}

impl PartialGame {
    pub fn known(&self) -> usize {
        self.known.len()
    }

    /// 値が分かる提携の超過だけを辞書式に最小化した配分 (分かる提携に限った仁)。
    ///
    /// 逐次 LP を有界にするため、1 人提携とその補集合の値が全て分かっている必要がある。
    /// 結果は真のゲームの仁とは限らないので、保証は [`Guarantee::Approximate`] にする。
    pub fn nucleolus(&self, domain: Domain) -> Result<NucleolusResult> {
        let n = self.players;
        let full = PlayerSet::grand(n);
        let mut absent = Vec::new();
        for i in 0..n {
            let single = PlayerSet::singleton(n, i);
            for set in [single.complement(), single] {
                if set.is_proper() && !self.known.contains_key(&set) {
                    absent.push(set);
                }
            }
        }
        if !absent.is_empty() {
            return Err(Error::InvalidArgument(format!(
                "分かる提携だけで解くには、1 人提携とその補集合の値が全て必要 ({} 個が足りない)",
                absent.len()
            )));
        }
        if !self.known.contains_key(&full) {
            return Err(Error::InvalidArgument("全体提携の値がない".into()));
        }
        let mut result = crate::nucleolus::oracle::nucleolus_with(
            self,
            domain,
            crate::nucleolus::oracle::default_tolerance(self),
        )?;
        result.guarantee = Guarantee::Approximate;
        Ok(result)
    }
}

impl SetFunction for PartialGame {
    fn players(&self) -> usize {
        self.players
    }

    fn value(&self, coalition: &PlayerSet) -> f64 {
        if coalition.is_empty() {
            return 0.0;
        }
        self.known.get(coalition).copied().unwrap_or(f64::NAN)
    }
}

impl OracleGame for PartialGame {
    fn excess_order<'a>(&'a self, x: &'a [f64]) -> Box<dyn Iterator<Item = (PlayerSet, f64)> + 'a> {
        let mut order: Vec<(PlayerSet, f64)> = self
            .known
            .iter()
            .filter(|(set, _)| set.is_proper())
            .map(|(set, v)| (set.clone(), v - set.sum(x)))
            .collect();
        order.sort_by(|a, b| b.1.total_cmp(&a.1).then_with(|| a.0.cmp(&b.0)));
        Box::new(order.into_iter())
    }

    fn scale(&self) -> f64 {
        self.known.values().fold(1.0, |acc, v| acc.max(v.abs()))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::nucleolus;

    const JSON: &str = r#"{
        "players": 3,
        "values": {"0": 0, "1": 0, "2": 0, "0,1": 4, "0, 2": 3, "2,1": 2, "0,1,2": 6}
    }"#;

    #[test]
    fn json_and_csv_give_same_game() {
        let from_json = parse_json(JSON).unwrap();
        let csv = "coalition,value\n0,0\n1,0\n2,0\n0|1,4\n0|2,3\n1|2,2\n0|1|2,6\n";
        let from_csv = parse_csv(csv).unwrap();
        assert_eq!(from_json, from_csv);
        let game = from_json.to_explicit(Missing::Error).unwrap();
        let expected = ExplicitGame::from_lex(&[0.0, 0.0, 0.0, 4.0, 3.0, 2.0, 6.0]).unwrap();
        assert_eq!(game, expected);
        // 書き出して読み直すと同じ。
        assert_eq!(parse_json(&from_json.to_json()).unwrap(), from_json);
    }

    #[test]
    fn array_form_and_cost_type() {
        let text = r#"{"type": "cost", "values": [
            {"coalition": [0], "value": 5}, {"coalition": [1], "value": 7},
            {"coalition": [0, 1], "value": 9}]}"#;
        let data = parse_json(text).unwrap();
        assert_eq!(data.kind, Kind::Cost);
        assert_eq!(data.players, 2);
        assert!(data.partial().is_err());
    }

    #[test]
    fn missing_values_are_reported_or_filled() {
        let csv = "coalition,value\n0,1\n1,1\n2,1\n0|1,3\n0|1|2,6\n";
        let data = parse_csv(csv).unwrap();
        assert_eq!(data.missing().len(), 2);
        let err = data.to_explicit(Missing::Error).unwrap_err().to_string();
        assert!(err.contains("{0, 2}") && err.contains("{1, 2}"), "{err}");
        let filled = data.to_explicit(Missing::Zero).unwrap();
        assert_eq!(filled.value(Coalition::from_players(&[0, 2])), 0.0);
    }

    #[test]
    fn partial_game_uses_only_known_coalitions() {
        // 全提携が分かっていれば、仁と一致する。
        let data = parse_json(JSON).unwrap();
        let full = data.to_explicit(Missing::Error).unwrap();
        let expected = nucleolus::nucleolus(&full).unwrap().allocation;
        let partial = data
            .partial()
            .unwrap()
            .nucleolus(Domain::Imputation)
            .unwrap();
        for (a, e) in partial.allocation.iter().zip(&expected) {
            assert!((a - e).abs() < 1e-7);
        }
        assert_eq!(partial.guarantee, Guarantee::Approximate);
        // 1 人提携の補集合 (2 人提携) が欠けていると解けない。
        let csv = "coalition,value\n0,0\n1,0\n2,0\n0|1,4\n0|1|2,6\n";
        assert!(
            parse_csv(csv)
                .unwrap()
                .partial()
                .unwrap()
                .nucleolus(Domain::Imputation)
                .is_err()
        );
    }

    #[test]
    fn rejects_bad_input() {
        assert!(parse_json(r#"{"players": 1, "values": {"1": 1}}"#).is_err()); // 人数の範囲外
        assert!(parse_json(r#"{"values": {"0": 1, "0": 2}}"#).is_ok()); // JSON のキー重複は後勝ち
        assert!(parse_json(r#"{"values": {"A": 1}}"#).is_err()); // 番号でない
        assert!(parse_csv("coalition,value\n0,1\n0,2\n").is_err());
        assert!(parse_csv("coalition,value\n0,1\n1,1\n").is_err()); // 全体提携がない
        assert!(parse_csv("name,value\n0,1\n").is_err());
    }
}