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
use std::{error::Error, fmt::Display, fmt::Formatter};

use serde_derive::Deserialize;

use crate::{
    line::Line,
    symbols::{hexagram::*, trigram::*},
};

/// A `Trigram` is a tuple of three [`Line`](../line/enum.Line.html)s. It can be converted into
/// a [`TrigramName`](enum.TrigramName.html) by calling `get_name()` on it. This is the building
/// block of a [`Hexagram`](../hexagram/struct.Hexagram.html).
#[derive(Clone, Debug)]
pub struct Trigram(pub Line, pub Line, pub Line);

impl Trigram {
    /// Get a `TrigramName` from a `Trigram` with or without changes.
    pub fn get_name(&self, with_changes: bool) -> TrigramName {
        use self::TrigramName::*;
        use crate::line::Line::*;

        let l1 = self.0.settle(with_changes);
        let l2 = self.1.settle(with_changes);
        let l3 = self.2.settle(with_changes);

        match (l1, l2, l3) {
            (Unbroken, Unbroken, Unbroken) => Qian, // "☰",
            (Broken, Broken, Broken) => Kun,        // "☷",
            (Broken, Broken, Unbroken) => Zhen,     // "☳",
            (Broken, Unbroken, Broken) => Kan,      // "☵",
            (Unbroken, Broken, Broken) => Gen,      // "☶",
            (Unbroken, Unbroken, Broken) => Xun,    // "☴",
            (Unbroken, Broken, Unbroken) => Li,     // "☲",
            (Broken, Unbroken, Unbroken) => Dui,    // "☱",
            // Per the "settling" above, this is unreachable
            _ => unreachable!(),
        }
    }

    /// Get this `Trigram`'s `Line`s. The lines are cloned.
    pub fn get_lines_as_vec(&self) -> Vec<Line> {
        vec![self.0.clone(), self.1.clone(), self.2.clone()]
    }

    /// Print the `Trigram` as large ASCII-art lines.
    pub fn print_big(&self) {
        use crate::symbols::big_line::BIG_LINE_SPACER;

        self.0.print_big();
        print!("{}", BIG_LINE_SPACER);
        self.1.print_big();
        print!("{}", BIG_LINE_SPACER);
        self.2.print_big();
        print!("{}", BIG_LINE_SPACER);
    }

    // Generate a new `Trigram` by using the coin toss method.
    pub fn from_coin_tosses() -> Self {
        Trigram(
            Line::from_coin_tosses(),
            Line::from_coin_tosses(),
            Line::from_coin_tosses(),
        )
    }
}

impl Default for Trigram {
    fn default() -> Self {
        Trigram(rand::random(), rand::random(), rand::random())
    }
}

/// Named trigrams according to the [Bagua](https://en.wikipedia.org/wiki/Bagua). This represents a
/// "settled" `Trigram` that will not "change."
#[derive(Deserialize, Clone, Debug)]
pub enum TrigramName {
    Dui,
    // 兌, Duì
    Gen,
    // 艮, Gèn
    Kan,
    // 坎, Kǎn
    Kun,
    // 坤, Kūn
    Li,
    // 離, Lí
    Qian,
    // 乾, Qián
    Xun,
    // 巽, Xùn
    Zhen, // 震, Zhèn
}

impl TrigramName {
    /// Get the unicode trigram symbol corresponding to this `TrigramName`.
    pub fn symbol(&self) -> &str {
        use self::TrigramName::*;
        match self {
            Qian => QIAN_SYMBOL,
            Kun => KUN_SYMBOL,
            Zhen => ZHEN_SYMBOL,
            Kan => KAN_SYMBOL,
            Gen => GEN_SYMBOL,
            Xun => XUN_SYMBOL,
            Li => LI_SYMBOL,
            Dui => DUI_SYMBOL,
        }
    }

    /// Get the romanized pronunciation of the `TrigramName`.
    pub fn romanized(&self) -> String {
        use self::TrigramName::*;
        match self {
            Qian => String::from("Qián"),
            Kun => String::from("Kūn"),
            Zhen => String::from("Zhèn"),
            Kan => String::from("Kǎn"),
            Gen => String::from("Gèn"),
            Xun => String::from("Xùn"),
            Li => String::from("Lí"),
            Dui => String::from("Duì"),
        }
    }

    /// Get the English translation of the `TrigramName`.
    pub fn english_translation(&self) -> String {
        use self::TrigramName::*;
        match self {
            Qian => String::from("The Creative"),
            Kun => String::from("The Receptive"),
            Zhen => String::from("The Arousing"),
            Kan => String::from("The Abysmal"),
            Gen => String::from("Keeping Still"),
            Xun => String::from("The Gentle"),
            Li => String::from("The Clinging"),
            Dui => String::from("The Joyous"),
        }
    }

    /// Get the attribute that the `TrigramName` represents.
    pub fn attribute(&self) -> String {
        use self::TrigramName::*;
        match self {
            Qian => String::from("strong"),
            Kun => String::from("devoted, yielding"),
            Zhen => String::from("inciting, movement"),
            Kan => String::from("dangerous"),
            Gen => String::from("resting"),
            Xun => String::from("penetrating"),
            Li => String::from("light-giving"),
            Dui => String::from("joyful"),
        }
    }

    /// Get the image that the `TrigramName` represents.
    pub fn image(&self) -> String {
        use self::TrigramName::*;
        match self {
            Qian => String::from("heaven"),
            Kun => String::from("earth"),
            Zhen => String::from("thunder"),
            Kan => String::from("water"),
            Gen => String::from("mountain"),
            Xun => String::from("wind, wood"),
            Li => String::from("fire"),
            Dui => String::from("lake"),
        }
    }

    /// Get the family relationship that the `TrigramName` represents.
    pub fn family_relationship(&self) -> String {
        use self::TrigramName::*;
        match self {
            Qian => String::from("father"),
            Kun => String::from("mother"),
            Zhen => String::from("first son"),
            Kan => String::from("second son"),
            Gen => String::from("third son"),
            Xun => String::from("first daughter"),
            Li => String::from("second daughter"),
            Dui => String::from("third daughter"),
        }
    }

    /// Create a new `TrigramName` from the trigram's rank/index.
    pub fn from_usize(number: usize) -> Result<Self, TrigramError> {
        use self::TrigramName::*;
        match number {
            1 => Ok(Qian),
            2 => Ok(Dui),
            3 => Ok(Li),
            4 => Ok(Zhen),
            5 => Ok(Xun),
            6 => Ok(Kan),
            7 => Ok(Gen),
            8 => Ok(Kun),
            _ => Err(TrigramError::IntegerOutOfRange),
        }
    }

    /// Get a `TrigramName`'s rank/index in the Bagua.
    pub fn number(&self) -> usize {
        use self::TrigramName::*;
        match self {
            Qian => 1,
            Dui => 2,
            Li => 3,
            Zhen => 4,
            Xun => 5,
            Kan => 6,
            Gen => 7,
            Kun => 8,
        }
    }
}

impl Display for TrigramName {
    fn fmt(&self, f: &mut Formatter) -> Result<(), std::fmt::Error> {
        writeln!(f, "{} (No. {})", self.symbol(), self.number())?;
        writeln!(f, "{} - {}", self.romanized(), self.english_translation())?;
        writeln!(f)?;
        writeln!(f, "Attribute: {}", self.attribute())?;
        writeln!(f, "Image in nature: {}", self.image())?;
        writeln!(f, "Family Relationship: {}", self.family_relationship())?;

        Ok(())
    }
}

/// A tuple containing two [`TrigramName`](enum.TrigramName.html)s. In the future, functionality
/// provided by this struct will be rolled in `Hexagram`s.
#[derive(Clone, Debug)]
pub struct TrigramNamePair(pub TrigramName, pub TrigramName);

impl TrigramNamePair {
    /// Create a new `TrigramNamePair` from two `TrigramName`s.
    pub fn new(above: TrigramName, below: TrigramName) -> Self {
        TrigramNamePair(above, below)
    }

    /// Get a `&str` to a unicode symbol representing the `TrigramNamePair`.
    pub fn as_symbol(&self) -> &'static str {
        use self::TrigramName::*;
        match self {
            TrigramNamePair(Qian, Qian) => QIAN_QIAN_SYMBOL,
            TrigramNamePair(Qian, Kun) => QIAN_KUN_SYMBOL,
            TrigramNamePair(Qian, Zhen) => QIAN_ZHEN_SYMBOL,
            TrigramNamePair(Qian, Kan) => QIAN_KAN_SYMBOL,
            TrigramNamePair(Qian, Gen) => QIAN_GEN_SYMBOL,
            TrigramNamePair(Qian, Xun) => QIAN_XUN_SYMBOL,
            TrigramNamePair(Qian, Li) => QIAN_LI_SYMBOL,
            TrigramNamePair(Qian, Dui) => QIAN_DUI_SYMBOL,
            TrigramNamePair(Kun, Qian) => KUN_QIAN_SYMBOL,
            TrigramNamePair(Kun, Kun) => KUN_KUN_SYMBOL,
            TrigramNamePair(Kun, Zhen) => KUN_ZHEN_SYMBOL,
            TrigramNamePair(Kun, Kan) => KUN_KAN_SYMBOL,
            TrigramNamePair(Kun, Gen) => KUN_GEN_SYMBOL,
            TrigramNamePair(Kun, Xun) => KUN_XUN_SYMBOL,
            TrigramNamePair(Kun, Li) => KUN_LI_SYMBOL,
            TrigramNamePair(Kun, Dui) => KUN_DUI_SYMBOL,
            TrigramNamePair(Zhen, Qian) => ZHEN_QIAN_SYMBOL,
            TrigramNamePair(Zhen, Kun) => ZHEN_KUN_SYMBOL,
            TrigramNamePair(Zhen, Zhen) => ZHEN_ZHEN_SYMBOL,
            TrigramNamePair(Zhen, Kan) => ZHEN_KAN_SYMBOL,
            TrigramNamePair(Zhen, Gen) => ZHEN_GEN_SYMBOL,
            TrigramNamePair(Zhen, Xun) => ZHEN_XUN_SYMBOL,
            TrigramNamePair(Zhen, Li) => ZHEN_LI_SYMBOL,
            TrigramNamePair(Zhen, Dui) => ZHEN_DUI_SYMBOL,
            TrigramNamePair(Kan, Qian) => KAN_QIAN_SYMBOL,
            TrigramNamePair(Kan, Kun) => KAN_KUN_SYMBOL,
            TrigramNamePair(Kan, Zhen) => KAN_ZHEN_SYMBOL,
            TrigramNamePair(Kan, Kan) => KAN_KAN_SYMBOL,
            TrigramNamePair(Kan, Gen) => KAN_GEN_SYMBOL,
            TrigramNamePair(Kan, Xun) => KAN_XUN_SYMBOL,
            TrigramNamePair(Kan, Li) => KAN_LI_SYMBOL,
            TrigramNamePair(Kan, Dui) => KAN_DUI_SYMBOL,
            TrigramNamePair(Gen, Qian) => GEN_QIAN_SYMBOL,
            TrigramNamePair(Gen, Kun) => GEN_KUN_SYMBOL,
            TrigramNamePair(Gen, Zhen) => GEN_ZHEN_SYMBOL,
            TrigramNamePair(Gen, Kan) => GEN_KAN_SYMBOL,
            TrigramNamePair(Gen, Gen) => GEN_GEN_SYMBOL,
            TrigramNamePair(Gen, Xun) => GEN_XUN_SYMBOL,
            TrigramNamePair(Gen, Li) => GEN_LI_SYMBOL,
            TrigramNamePair(Gen, Dui) => GEN_DUI_SYMBOL,
            TrigramNamePair(Xun, Qian) => XUN_QIAN_SYMBOL,
            TrigramNamePair(Xun, Kun) => XUN_KUN_SYMBOL,
            TrigramNamePair(Xun, Zhen) => XUN_ZHEN_SYMBOL,
            TrigramNamePair(Xun, Kan) => XUN_KAN_SYMBOL,
            TrigramNamePair(Xun, Gen) => XUN_GEN_SYMBOL,
            TrigramNamePair(Xun, Xun) => XUN_XUN_SYMBOL,
            TrigramNamePair(Xun, Li) => XUN_LI_SYMBOL,
            TrigramNamePair(Xun, Dui) => XUN_DUI_SYMBOL,
            TrigramNamePair(Li, Qian) => LI_QIAN_SYMBOL,
            TrigramNamePair(Li, Kun) => LI_KUN_SYMBOL,
            TrigramNamePair(Li, Zhen) => LI_ZHEN_SYMBOL,
            TrigramNamePair(Li, Kan) => LI_KAN_SYMBOL,
            TrigramNamePair(Li, Gen) => LI_GEN_SYMBOL,
            TrigramNamePair(Li, Xun) => LI_XUN_SYMBOL,
            TrigramNamePair(Li, Li) => LI_LI_SYMBOL,
            TrigramNamePair(Li, Dui) => LI_DUI_SYMBOL,
            TrigramNamePair(Dui, Qian) => DUI_QIAN_SYMBOL,
            TrigramNamePair(Dui, Kun) => DUI_KUN_SYMBOL,
            TrigramNamePair(Dui, Zhen) => DUI_ZHEN_SYMBOL,
            TrigramNamePair(Dui, Kan) => DUI_KAN_SYMBOL,
            TrigramNamePair(Dui, Gen) => DUI_GEN_SYMBOL,
            TrigramNamePair(Dui, Xun) => DUI_XUN_SYMBOL,
            TrigramNamePair(Dui, Li) => DUI_LI_SYMBOL,
            TrigramNamePair(Dui, Dui) => DUI_DUI_SYMBOL,
        }
    }

    /// Get the number of the `TrigramNamePair` according to the King Wen Sequence.
    pub fn king_wen_sequence_number(&self) -> usize {
        use self::TrigramName::*;
        match self {
            TrigramNamePair(Qian, Qian) => 1,
            TrigramNamePair(Qian, Kun) => 12,
            TrigramNamePair(Qian, Zhen) => 25,
            TrigramNamePair(Qian, Kan) => 6,
            TrigramNamePair(Qian, Gen) => 33,
            TrigramNamePair(Qian, Xun) => 44,
            TrigramNamePair(Qian, Li) => 13,
            TrigramNamePair(Qian, Dui) => 10,
            TrigramNamePair(Kun, Qian) => 11,
            TrigramNamePair(Kun, Kun) => 2,
            TrigramNamePair(Kun, Zhen) => 24,
            TrigramNamePair(Kun, Kan) => 7,
            TrigramNamePair(Kun, Gen) => 15,
            TrigramNamePair(Kun, Xun) => 46,
            TrigramNamePair(Kun, Li) => 36,
            TrigramNamePair(Kun, Dui) => 19,
            TrigramNamePair(Zhen, Qian) => 34,
            TrigramNamePair(Zhen, Kun) => 16,
            TrigramNamePair(Zhen, Zhen) => 51,
            TrigramNamePair(Zhen, Kan) => 40,
            TrigramNamePair(Zhen, Gen) => 62,
            TrigramNamePair(Zhen, Xun) => 32,
            TrigramNamePair(Zhen, Li) => 55,
            TrigramNamePair(Zhen, Dui) => 54,
            TrigramNamePair(Kan, Qian) => 5,
            TrigramNamePair(Kan, Kun) => 8,
            TrigramNamePair(Kan, Zhen) => 3,
            TrigramNamePair(Kan, Kan) => 29,
            TrigramNamePair(Kan, Gen) => 39,
            TrigramNamePair(Kan, Xun) => 48,
            TrigramNamePair(Kan, Li) => 63,
            TrigramNamePair(Kan, Dui) => 60,
            TrigramNamePair(Gen, Qian) => 26,
            TrigramNamePair(Gen, Kun) => 23,
            TrigramNamePair(Gen, Zhen) => 27,
            TrigramNamePair(Gen, Kan) => 4,
            TrigramNamePair(Gen, Gen) => 52,
            TrigramNamePair(Gen, Xun) => 18,
            TrigramNamePair(Gen, Li) => 22,
            TrigramNamePair(Gen, Dui) => 41,
            TrigramNamePair(Xun, Qian) => 9,
            TrigramNamePair(Xun, Kun) => 20,
            TrigramNamePair(Xun, Zhen) => 42,
            TrigramNamePair(Xun, Kan) => 59,
            TrigramNamePair(Xun, Gen) => 53,
            TrigramNamePair(Xun, Xun) => 57,
            TrigramNamePair(Xun, Li) => 37,
            TrigramNamePair(Xun, Dui) => 61,
            TrigramNamePair(Li, Qian) => 14,
            TrigramNamePair(Li, Kun) => 35,
            TrigramNamePair(Li, Zhen) => 21,
            TrigramNamePair(Li, Kan) => 64,
            TrigramNamePair(Li, Gen) => 56,
            TrigramNamePair(Li, Xun) => 50,
            TrigramNamePair(Li, Li) => 30,
            TrigramNamePair(Li, Dui) => 38,
            TrigramNamePair(Dui, Qian) => 43,
            TrigramNamePair(Dui, Kun) => 45,
            TrigramNamePair(Dui, Zhen) => 17,
            TrigramNamePair(Dui, Kan) => 47,
            TrigramNamePair(Dui, Gen) => 31,
            TrigramNamePair(Dui, Xun) => 28,
            TrigramNamePair(Dui, Li) => 49,
            TrigramNamePair(Dui, Dui) => 58,
        }
    }

    /// Get the number of the `TrigramNamePair` according to the [Binary Sequence](https://en.wikipedia.org/wiki/Bagua#Fu_Xi_%22Earlier_Heaven%22).
    /// **currently unimplemented!**
    pub fn binary_sequence_number(&self) -> usize {
        unimplemented!()
    }

    /// Get the number of the `TrigramNamePair` according to the [Mawangdui Sequence](https://en.wikipedia.org/wiki/Mawangdui).
    /// **currently unimplemented!**
    pub fn mawangdui_sequence_number(&self) -> usize {
        unimplemented!()
    }
}

/// Errors related to `Trigram`s.
#[derive(Debug)]
pub enum TrigramError {
    /// Thrown when creating a `TrigramName` from an integer, if the given integer is not between 1-8 inclusive.
    IntegerOutOfRange,
}

static INTEGER_OUT_OF_RANGE_ERROR_MSG: &str =
    "Invalid conversion from usize to TrigramName, make sure your usize is between 1-8 inclusive";

impl Display for TrigramError {
    fn fmt(&self, f: &mut Formatter) -> Result<(), std::fmt::Error> {
        use self::TrigramError::*;
        match self {
            IntegerOutOfRange => write!(f, "{}", INTEGER_OUT_OF_RANGE_ERROR_MSG),
        }
    }
}

impl Error for TrigramError {
    fn description(&self) -> &str {
        use self::TrigramError::*;
        match self {
            IntegerOutOfRange => INTEGER_OUT_OF_RANGE_ERROR_MSG,
        }
    }
}