Skip to main content

Crate pace26io

Crate pace26io 

Source
Expand description

§PACE 2026 I/O Crate

This crate implements parsers and writers for the PACE 2026 file format. It was originally developed for the official PACE tools (e.g., verifier and Stride). As such, it offers a great deal of flexibility including quite pedantic parsing modes. Most users should stay away from this mess and rather use the simplified reader interface:

§Simplified reader interface

We offer a simplified interface in pace::simplified::Instance intend to be used by solver implementers. To read an instance, you may use:

use std::{fs::File, io::BufReader};
use pace26io::{binary_tree::*, pace::simplified::*};

type Builder = IndexedBinTreeBuilder; // If you do not care about inner node indices, use BinTreeBuilder
type Node = <Builder as TreeBuilder>::Node;

// A solver would typically use `std::io::stdin().lock()` instead of reading a file
let mut input = BufReader::new(File::open("examples/tiny01.nw").unwrap());

// Parse instance
let mut tree_builder = Builder::default();
let instance = Instance::try_read(&mut input, &mut tree_builder)
    .expect("Valid PACE26 Instance");

println!("# Found {} trees", instance.trees.len());

This interface will ignore most parser warnings and only raise errors if parsing cannot continue. We recommend the Stride tool to debug broken instances.

§Tree representation

We offer only rudimentary tree representations, more specifically binary_tree::BinTree and binary_tree::IndexedBinTree. The latter also stores node ids of internal nodes, used –for instance– for graph parameters.

We expect that solvers typically need more control over their data structures. For this reason, the crate is designed to make implementation of own tree structures straightforward. You need to provide

§Writing Newick strings

A Newick String writer is provided for each data structure implementing binary_tree::TopDownCursor. For further details see newick::NewickWriter.

Modules§

binary_tree
newick
pace