style.hpp File Reference

Style metric (doc 05 §39.2): how tidy a set of tracks is, per connection and per board. More...

#include <vector>
#include <nlohmann/json.hpp>
#include "model/board.hpp"

Go to the source code of this file.

Classes
struct	tmk::passes::StyleOptions
struct	tmk::passes::ConnectionStyle
	One connection: copper of one net from one end to the next. More...
struct	tmk::passes::StyleReport

Namespaces
namespace	tmk
namespace	tmk::passes

Functions
StyleReport	tmk::passes::measure_style (const model::Board &b, const std::vector< model::Track > &tracks, const std::vector< model::ArcTrack > &arcs, const std::vector< model::Via > &vias, const StyleOptions &opt={})
	Measures tracks, arcs and vias (any subset of a board's copper, e.g.
nlohmann::json	tmk::passes::style_json (const model::Board &b, const StyleReport &r, bool per_connection=false)
	The style object of the route summary and of tracemaker style --json.

Detailed Description

Style metric (doc 05 §39.2): how tidy a set of tracks is, per connection and per board.

It only measures; no pass optimises it. Everything is counted in integers (nm, cross and dot products), so the numbers are the same on every machine and at every thread count.

The patterns follow what layout reviewers flag by eye; tscircuit's pcb-trace-linter (segments off the 45 degree directions) and check-ugly-traces (removable jogs) were read for which patterns to count. No code of theirs is used.

Definition in file style.hpp.