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
use super::Error;
use crate::topology::Topology;
use num_traits::FromPrimitive;
use num_traits::ToPrimitive;
use num_traits::Zero;
use rayon::iter::IntoParallelRefIterator as _;
use rayon::iter::ParallelIterator as _;
use std::collections::HashSet;
use std::iter::Sum;
use std::ops::AddAssign;
use std::ops::Sub;
use std::ops::SubAssign;
/// Diagnostic data for a Fiduccia-Mattheyses run.
#[non_exhaustive]
#[derive(Debug, Default)]
pub struct Metadata {
/// Move count for each pass, included discarded moves by history rewinds.
pub moves_per_pass: Vec<usize>,
/// Number of moves that have been discarded for each pass.
pub rewinded_moves_per_pass: Vec<usize>,
}
/// Some data used to rewind the partition array to a previous state, should the
/// edge cut in said state is better.
struct Move {
/// The index of the vertex.
vertex: usize,
/// The index of the part the vertex was in before the move.
///
/// The target part is 1 - initial_part, because there are only two parts.
initial_part: usize,
}
fn fiduccia_mattheyses<W, T>(
partition: &mut [usize],
weights: &[W],
adjacency: T,
max_passes: usize,
max_moves_per_pass: usize,
max_imbalance: Option<f64>,
max_bad_moves_in_a_row: usize,
) -> Metadata
where
W: FmWeight,
T: Topology<i64> + Sync,
{
debug_assert!(!partition.is_empty());
debug_assert_eq!(partition.len(), weights.len());
debug_assert_eq!(partition.len(), adjacency.len());
debug_assert!(*partition.iter().max().unwrap() < 2);
let mut part_weights =
crate::imbalance::compute_parts_load(partition, 2, weights.par_iter().cloned());
// Enforce part weights to be below this value.
let max_part_weight = match max_imbalance {
Some(max_imbalance) => {
let total_weight: W = part_weights.iter().cloned().sum();
let ideal_part_weight = total_weight.to_f64().unwrap() / 2.0;
W::from_f64(ideal_part_weight + max_imbalance * ideal_part_weight).unwrap()
}
None => *part_weights.iter().max_by(crate::partial_cmp).unwrap(),
};
let mut best_edge_cut = adjacency.edge_cut(partition);
tracing::info!("Initial edge cut: {}", best_edge_cut);
let max_possible_gain = (0..partition.len())
.map(|vertex| {
adjacency
.neighbors(vertex)
.fold(0, |acc, (_, edge_weight)| acc + edge_weight)
})
.max()
.unwrap();
// Maps (-max_possible_gain..=max_possible_gain) to nodes that have that gain.
let mut gain_to_vertex = {
let possible_gain_count = (2 * max_possible_gain + 1) as usize;
vec![HashSet::new(); possible_gain_count].into_boxed_slice()
};
// Maps a gain value to its index in gain_to_vertex.
let gain_table_idx = |gain: i64| (gain + max_possible_gain) as usize;
// Either Some(gain) or None if the vertex is locked.
let mut vertex_to_gain = vec![None; adjacency.len()].into_boxed_slice();
let mut moves_per_pass = Vec::new();
let mut rewinded_moves_per_pass = Vec::new();
for _ in 0..max_passes {
let old_edge_cut = best_edge_cut;
let mut current_edge_cut = best_edge_cut;
let mut move_with_best_edge_cut = None;
// monitors for each pass the number of subsequent moves that increase
// the edge cut. It may be beneficial in some situations to allow a
// certain amount of them. Performing bad moves can open up new
// sequences of good moves.
let mut num_bad_move = 0;
// Avoid copying partition arrays around and instead record an history
// of moves, so that even if bad moves are performed during the pass, we
// can look back and pick the best partition.
let mut move_history: Vec<Move> = Vec::new();
for set in &mut *gain_to_vertex {
set.clear();
}
for (vertex, initial_part) in partition.iter().enumerate() {
let gain = adjacency
.neighbors(vertex)
.map(|(neighbor, edge_weight)| {
if partition[neighbor] == *initial_part {
-edge_weight
} else {
edge_weight
}
})
.sum();
vertex_to_gain[vertex] = Some(gain);
gain_to_vertex[gain_table_idx(gain)].insert(vertex);
}
// enter pass loop
// The number of iteration of the pas loop is at most the
// number of vertices in the mesh. However, if too many subsequent
// bad moves are performed, the loop will break early
for move_num in 0..max_moves_per_pass {
let (moved_vertex, move_gain) = match gain_to_vertex
.iter()
.rev()
.zip((-max_possible_gain..=max_possible_gain).rev())
.find_map(|(vertices, gain)| {
let (best_vertex, _) = vertices
.iter()
.filter_map(|vertex| {
let weight = weights[*vertex];
let initial_part = partition[*vertex];
let target_part = 1 - initial_part;
let target_part_weight = part_weights[target_part] + weight;
if max_part_weight < target_part_weight {
return None;
}
Some((*vertex, target_part_weight))
})
.min_by(|(_, max_part_weight0), (_, max_part_weight1)| {
crate::partial_cmp(max_part_weight0, max_part_weight1)
})?;
Some((best_vertex, gain))
}) {
Some(v) => v,
None => break,
};
if move_gain <= 0 {
if num_bad_move >= max_bad_moves_in_a_row {
tracing::info!("reached max bad move in a row");
break;
}
num_bad_move += 1;
} else {
// A good move breaks the bad moves sequence.
num_bad_move = 0;
}
vertex_to_gain[moved_vertex] = None;
gain_to_vertex[gain_table_idx(move_gain)].remove(&moved_vertex);
let initial_part = partition[moved_vertex];
let target_part = 1 - initial_part;
partition[moved_vertex] = target_part;
part_weights[initial_part] -= weights[moved_vertex];
part_weights[target_part] += weights[moved_vertex];
move_history.push(Move {
vertex: moved_vertex,
initial_part,
});
tracing::info!(moved_vertex, initial_part, target_part, "moved vertex");
current_edge_cut -= move_gain;
debug_assert_eq!(current_edge_cut, adjacency.edge_cut(partition));
if current_edge_cut < best_edge_cut {
best_edge_cut = current_edge_cut;
move_with_best_edge_cut = Some(move_num);
}
for (neighbor, edge_weight) in adjacency.neighbors(moved_vertex) {
let outdated_gain = match vertex_to_gain[neighbor] {
Some(v) => v,
None => continue,
};
let updated_gain = if partition[neighbor] == initial_part {
outdated_gain + 2 * edge_weight
} else {
outdated_gain - 2 * edge_weight
};
vertex_to_gain[neighbor] = Some(updated_gain);
gain_to_vertex[gain_table_idx(outdated_gain)].remove(&neighbor);
gain_to_vertex[gain_table_idx(updated_gain)].insert(neighbor);
}
}
let rewind_to = match move_with_best_edge_cut {
Some(v) => v + 1,
None => 0,
};
moves_per_pass.push(move_history.len());
rewinded_moves_per_pass.push(move_history.len() - rewind_to);
tracing::info!("rewinding {} moves", move_history.len() - rewind_to);
for Move {
vertex,
initial_part,
} in move_history.drain(rewind_to..)
{
partition[vertex] = initial_part;
part_weights[initial_part] += weights[vertex];
part_weights[1 - initial_part] -= weights[vertex];
}
if old_edge_cut <= best_edge_cut {
break;
}
}
tracing::info!("final edge cut: {}", best_edge_cut);
Metadata {
moves_per_pass,
rewinded_moves_per_pass,
}
}
/// Trait alias for values accepted as weights by [FiducciaMattheyses].
pub trait FmWeight
where
Self: Copy + std::fmt::Debug + Send + Sync,
Self: Sum + PartialOrd + FromPrimitive + ToPrimitive + Zero,
Self: Sub<Output = Self> + AddAssign + SubAssign,
{
}
impl<T> FmWeight for T
where
Self: Copy + std::fmt::Debug + Send + Sync,
Self: Sum + PartialOrd + FromPrimitive + ToPrimitive + Zero,
Self: Sub<Output = Self> + AddAssign + SubAssign,
{
}
/// FiducciaMattheyses
///
/// An implementation of the original Fiduccia Mattheyses topologic algorithm
/// for graph partitioning.
///
/// This algorithm repeats an iterative pass during which a set of graph
/// vertices are assigned to a new part, reducing the overall cutsize of the
/// partition. As opposed to the Kernighan-Lin algorithm, during each pass
/// iteration, only one vertex is moved at a time. The algorithm thus does not
/// preserve partition weights balance and may produce an unbalanced partition.
///
/// For partitioning in more than two parts, see [`ArcSwap`][crate::ArcSwap].
///
/// # Example
///
/// ```rust
/// # fn main() -> Result<(), coupe::Error> {
/// use coupe::Partition as _;
/// use coupe::Point2D;
///
/// // swap
/// // 0 1 0 1
/// // +--+--+--+
/// // | | | |
/// // +--+--+--+
/// // 0 0 1 1
/// let points = [
/// Point2D::new(0., 0.),
/// Point2D::new(1., 0.),
/// Point2D::new(2., 0.),
/// Point2D::new(3., 0.),
/// Point2D::new(0., 1.),
/// Point2D::new(1., 1.),
/// Point2D::new(2., 1.),
/// Point2D::new(3., 1.),
/// ];
/// let weights = [1.0; 8];
/// let mut partition = [0, 0, 1, 1, 0, 1, 0, 1];
///
/// let mut adjacency = sprs::CsMat::empty(sprs::CSR, 0);
/// adjacency.insert(0, 1, 1);
/// adjacency.insert(1, 2, 1);
/// adjacency.insert(2, 3, 1);
/// adjacency.insert(4, 5, 1);
/// adjacency.insert(5, 6, 1);
/// adjacency.insert(6, 7, 1);
/// adjacency.insert(0, 4, 1);
/// adjacency.insert(1, 5, 1);
/// adjacency.insert(2, 6, 1);
/// adjacency.insert(3, 7, 1);
///
/// // symmetry
/// adjacency.insert(1, 0, 1);
/// adjacency.insert(2, 1, 1);
/// adjacency.insert(3, 2, 1);
/// adjacency.insert(5, 4, 1);
/// adjacency.insert(6, 5, 1);
/// adjacency.insert(7, 6, 1);
/// adjacency.insert(4, 0, 1);
/// adjacency.insert(5, 1, 1);
/// adjacency.insert(6, 2, 1);
/// adjacency.insert(7, 3, 1);
///
/// // Set the imbalance tolerance to 25% to provide enough room for FM to do
/// // the swap.
/// coupe::FiducciaMattheyses { max_imbalance: Some(0.25), ..Default::default() }
/// .partition(&mut partition, (adjacency.view(), &weights))?;
///
/// assert_eq!(partition, [0, 0, 1, 1, 0, 0, 1, 1]);
/// # Ok(())
/// # }
/// ```
///
/// # Reference
///
/// Fiduccia, C. M., Mattheyses, R. M. (1982). A linear-time heuristic for
/// improving network partitions. *DAC'82: Proceeding of the 19th Design
/// Automation Conference*.
#[derive(Debug, Clone, Copy, Default)]
pub struct FiducciaMattheyses {
/// If `Some(max)` then the algorithm will not do more than `max` passes.
/// If `None` then it will stop on the first non-fruitful pass.
pub max_passes: Option<usize>,
/// If `Some(max)` then the algorithm will not do more than `max` moves per
/// pass. If `None` then passes will stop when no more vertices yield a
/// positive gain, and no more bad moves can be made.
pub max_moves_per_pass: Option<usize>,
/// If `Some(max)` then the algorithm will not move vertices in ways that
/// the imbalance goes over `max`. If `None`, then it will default to the
/// imbalance of the input partition.
pub max_imbalance: Option<f64>,
/// How many moves that yield negative gains can be made before a pass ends.
pub max_bad_move_in_a_row: usize,
}
impl<'a, T, W> crate::Partition<(T, &'a [W])> for FiducciaMattheyses
where
T: Topology<i64> + Sync,
W: FmWeight,
{
type Metadata = Metadata;
type Error = Error;
fn partition(
&mut self,
part_ids: &mut [usize],
(adjacency, weights): (T, &'a [W]),
) -> Result<Self::Metadata, Self::Error> {
if part_ids.is_empty() {
return Ok(Metadata::default());
}
if part_ids.len() != weights.len() {
return Err(Error::InputLenMismatch {
expected: part_ids.len(),
actual: weights.len(),
});
}
if part_ids.len() != adjacency.len() {
return Err(Error::InputLenMismatch {
expected: part_ids.len(),
actual: adjacency.len(),
});
}
if 1 < *part_ids.iter().max().unwrap_or(&0) {
return Err(Error::BiPartitioningOnly);
}
let metadata = fiduccia_mattheyses(
part_ids,
weights,
adjacency,
self.max_passes.unwrap_or(usize::MAX),
self.max_moves_per_pass.unwrap_or(usize::MAX),
self.max_imbalance,
self.max_bad_move_in_a_row,
);
Ok(metadata)
}
}