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
// Copyright (c) 2016-2021 Frank Fischer <frank-fischer@shadow-soft.de>
//
// This program is free software: you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>
//
//! Reading files in `SteinLib` format.
//!
//! This reader supports the following extensions to the `SteinLib` format:
//!
//! 1. Additional drawing attributes section
//!
//! ```ignore
//! SECTION Drawing
//! A <u> <v> <attribute>...
//! E <u> <v> <attribute>...
//! END
//! ```
//!
//! This is a list of drawing attributes for each edge. Possible
//! attributes are
//! - `bl` the arc should be bend to the left
//! - `br` the arc should be bend to the right
use crate::IndexGraph;
use std::result;
mod parser;
pub use self::parser::{read, SteinlibError as Error};
/// Type of values with optional error code.
pub type Result<T> = result::Result<T, Error>;
/// Edge drawing attributes.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum EdgeAttr {
/// Arc should be bend to the left.
BendLeft,
/// Arc should be bend to the right.
BendRight,
}
/// An SteinLib instance.
pub struct Instance<G>
where
G: IndexGraph,
{
/// The graph.
pub graph: G,
/// The edge weights.
pub weights: Vec<f64>,
/// The node coordinates.
pub coordinates: Vec<Vec<f64>>,
/// The edge attributes.
pub edgeattrs: Vec<Vec<EdgeAttr>>,
}