From 1daa7383207bad9f1812094deaa3dd296858462a Mon Sep 17 00:00:00 2001 From: Kneasle Date: Sat, 20 Jul 2024 19:35:56 +0100 Subject: [PATCH] Revert changes to base call params --- monument/cli/src/toml_file.rs | 19 +++++++++---------- monument/doc/src/SUMMARY.md | 8 ++++---- monument/doc/src/params/base_bob_weight.md | 5 ----- monument/doc/src/params/base_bobs_only.md | 8 -------- monument/doc/src/params/base_calls.md | 8 ++++---- monument/doc/src/params/base_single_weight.md | 5 ----- monument/doc/src/params/bob_weight.md | 6 +++++- monument/doc/src/params/bobs_only.md | 7 +++++++ monument/doc/src/params/single_weight.md | 5 +++++ .../{base_singles_only.md => singles_only.md} | 4 ++-- 10 files changed, 36 insertions(+), 39 deletions(-) delete mode 100644 monument/doc/src/params/base_bob_weight.md delete mode 100644 monument/doc/src/params/base_bobs_only.md delete mode 100644 monument/doc/src/params/base_single_weight.md create mode 100644 monument/doc/src/params/single_weight.md rename monument/doc/src/params/{base_singles_only.md => singles_only.md} (58%) diff --git a/monument/cli/src/toml_file.rs b/monument/cli/src/toml_file.rs index 5131106d..dc100857 100644 --- a/monument/cli/src/toml_file.rs +++ b/monument/cli/src/toml_file.rs @@ -107,15 +107,15 @@ pub struct TomlFile { /// If `true`, then singles are excluded from `base_calls`. This is mutually exclusive with /// `singles_only` #[serde(default)] - base_bobs_only: bool, + bobs_only: bool, /// If `true`, then bobs are excluded from `base_calls`. This is mutually exclusive with /// `bobs_only`. #[serde(default)] - base_singles_only: bool, + singles_only: bool, /// The weight given to each bob from `base_calls` - base_bob_weight: Option, + bob_weight: Option, /// The weight given to each single from `base_calls` - base_single_weight: Option, + single_weight: Option, /// Which calls to use in the compositions #[serde(default)] calls: Vec, @@ -296,18 +296,18 @@ impl TomlFile { // Suggest `{bobs,singles}_only` if the user gives calls an extreme negative weight const BIG_NEGATIVE_WEIGHT: f32 = -100.0; - if let Some(w) = self.base_bob_weight { + if let Some(w) = self.bob_weight { if w <= BIG_NEGATIVE_WEIGHT { log::warn!("It looks like you're trying to make a singles only composition; consider using `singles_only = true` explicitly."); } } - if let Some(w) = self.base_single_weight { + if let Some(w) = self.single_weight { if w <= BIG_NEGATIVE_WEIGHT { log::warn!("It looks like you're trying to make a bobs only composition; consider using `bobs_only = true` explicitly."); } } // Check that `{bobs,singles}_only` aren't set at the same time - if self.base_bobs_only && self.base_singles_only { + if self.bobs_only && self.singles_only { return Err(anyhow::Error::msg( "Composition can't be both `bobs_only` and `singles_only`", )); @@ -316,9 +316,8 @@ impl TomlFile { Ok(monument::parameters::base_calls( id_gen, base_call_type, - (!self.base_singles_only).then_some(self.base_bob_weight.unwrap_or(DEFAULT_BOB_WEIGHT)), - (!self.base_bobs_only) - .then_some(self.base_single_weight.unwrap_or(DEFAULT_SINGLE_WEIGHT)), + (!self.singles_only).then_some(self.bob_weight.unwrap_or(DEFAULT_BOB_WEIGHT)), + (!self.bobs_only).then_some(self.single_weight.unwrap_or(DEFAULT_SINGLE_WEIGHT)), stage, )) } diff --git a/monument/doc/src/SUMMARY.md b/monument/doc/src/SUMMARY.md index bf08674c..c37d1f8a 100644 --- a/monument/doc/src/SUMMARY.md +++ b/monument/doc/src/SUMMARY.md @@ -32,10 +32,10 @@ - [require_atw = false](./params/require_atw.md) - [Calls](./params/_sec04-calls.md) - [base_calls = "near"](./params/base_calls.md) - - [base_bobs_only = false](./params/base_bobs_only.md) - - [base_singles_only = false](./params/base_singles_only.md) - - [base_bob_weight = -1.8](./params/base_bob_weight.md) - - [base_single_weight = -2.5](./params/base_single_weight.md) + - [bobs_only = false](./params/bobs_only.md) + - [singles_only = false](./params/singles_only.md) + - [bob_weight = -1.8](./params/bob_weight.md) + - [single_weight = -2.5](./params/single_weight.md) - [calls = \[\]](./params/calls.md) - [place_notation](./params/calls/place_notation.md) - [symbol](./params/calls/symbol.md) diff --git a/monument/doc/src/params/base_bob_weight.md b/monument/doc/src/params/base_bob_weight.md deleted file mode 100644 index 0f16365d..00000000 --- a/monument/doc/src/params/base_bob_weight.md +++ /dev/null @@ -1,5 +0,0 @@ -# `base_bob_weight` - -**Defaults to `-1.8`.** - -Sets the score given to the bob generated by `base_calls`. diff --git a/monument/doc/src/params/base_bobs_only.md b/monument/doc/src/params/base_bobs_only.md deleted file mode 100644 index 61ab9e70..00000000 --- a/monument/doc/src/params/base_bobs_only.md +++ /dev/null @@ -1,8 +0,0 @@ -# `base_bobs_only` - -**Defaults to `false`.** - -If `true`, then [`base_calls`](base_calls.md) will only generate bobs, and not singles. - -Note that this is incompatible with [`base_singles_only`](base_singles_only.md) (since a call set -can't be both bobs-only and singles-only). diff --git a/monument/doc/src/params/base_calls.md b/monument/doc/src/params/base_calls.md index 1b4330d6..5f317e6e 100644 --- a/monument/doc/src/params/base_calls.md +++ b/monument/doc/src/params/base_calls.md @@ -17,7 +17,7 @@ base_calls = "none" # no base calls, only what you've added These can be customised with these other parameters: -- [`base_bobs_only`](base_bobs_only.md) -- [`base_singles_only`](base_singles_only.md) -- [`base_bob_weight`](base_bob_weight.md) -- [`base_single_weight`](base_single_weight.md) +- [`bobs_only`](bobs_only.md) +- [`singles_only`](singles_only.md) +- [`bob_weight`](bob_weight.md) +- [`single_weight`](single_weight.md) diff --git a/monument/doc/src/params/base_single_weight.md b/monument/doc/src/params/base_single_weight.md deleted file mode 100644 index be9c4866..00000000 --- a/monument/doc/src/params/base_single_weight.md +++ /dev/null @@ -1,5 +0,0 @@ -# `base_single_weight` - -**Defaults to `-2.5`.** - -Sets the score given to the single generated by `base_calls`. diff --git a/monument/doc/src/params/bob_weight.md b/monument/doc/src/params/bob_weight.md index 33950ae6..7af0bae8 100644 --- a/monument/doc/src/params/bob_weight.md +++ b/monument/doc/src/params/bob_weight.md @@ -1 +1,5 @@ -# bob_weight +# `bob_weight` + +**Defaults to `-1.8`.** + +Sets the score given to the bob generated by [`base_calls`](base_calls.md). diff --git a/monument/doc/src/params/bobs_only.md b/monument/doc/src/params/bobs_only.md index 67c1f02f..3563d74f 100644 --- a/monument/doc/src/params/bobs_only.md +++ b/monument/doc/src/params/bobs_only.md @@ -1 +1,8 @@ # `bobs_only` + +**Defaults to `false`.** + +If `true`, then [`base_calls`](base_calls.md) will only generate bobs, and not singles. + +Note that this is incompatible with [`singles_only`](singles_only.md) (since a set of calls +can't be both bobs-only and singles-only). diff --git a/monument/doc/src/params/single_weight.md b/monument/doc/src/params/single_weight.md new file mode 100644 index 00000000..e0809c8b --- /dev/null +++ b/monument/doc/src/params/single_weight.md @@ -0,0 +1,5 @@ +# `single_weight` + +**Defaults to `-2.5`.** + +Sets the score given to the single generated by [`base_calls`](base_calls.md). diff --git a/monument/doc/src/params/base_singles_only.md b/monument/doc/src/params/singles_only.md similarity index 58% rename from monument/doc/src/params/base_singles_only.md rename to monument/doc/src/params/singles_only.md index fdecfff0..81275194 100644 --- a/monument/doc/src/params/base_singles_only.md +++ b/monument/doc/src/params/singles_only.md @@ -1,8 +1,8 @@ -# `base_singles_only` +# `singles_only` **Defaults to `false`.** If `true`, then [`base_calls`](base_calls.md) will only generate singles, and not bobs. -Note that this is incompatible with [`base_bobs_only`](base_bobs_only.md) (since a call set +Note that this is incompatible with [`bobs_only`](bobs_only.md) (since a set of calls can't be both bobs-only and singles-only).