remove redundant comments

Author: theastrogoth

SerialPrograms/Source/Pokemon/Pokemon_BdspRng.cpp

@@ -15,19 +15,12 @@ namespace PokemonAutomation{
 namespace Pokemon{
 
 
-//  Big enough that a generation can never read past the values the window holds.
-//  The size has no effect on results; it is purely a cache.
+
 const size_t STATIC_SEARCH_WINDOW = 64;
 
-//  How often a long search checks whether the user has stopped the program.
 const uint64_t CANCEL_CHECK_INTERVAL = 65536;
 
 
-
-//
-//  Xoroshiro128+, BDSP flavor
-//
-
 uint64_t bdsp_splitmix64(uint64_t seed){
     seed = 0xBF58476D1CE4E5B9 * (seed ^ (seed >> 30));
     seed = 0x94D049BB133111EB * (seed ^ (seed >> 27));
@@ -154,21 +147,15 @@ bool bdsp_is_shiny(uint32_t pid, uint16_t tsv){
 
 
 
-//
-//  Generation
-//
 
 namespace{
 
-//  Reads straight off a generator. Used for one-off generation.
 struct DirectSource{
     Xorshift128& rng;
     uint32_t next(){ return bdsp_gen_transform(rng.next()); }
     uint32_t next(uint32_t modulo){ return next() % modulo; }
 };
 
-//  Reads off a sliding window. Used when searching a range of advances, where
-//  consecutive advances re-read almost all of the same values.
 struct WindowSource{
     Xorshift128List<STATIC_SEARCH_WINDOW>& list;
     uint32_t next(){ return list.next_gen(); }
@@ -178,14 +165,12 @@ struct WindowSource{
 }
 
 
-//  Force the PID to be non-shiny against the player's own TSV.
 static void force_not_shiny(uint32_t& pid, uint16_t tsv){
     if (bdsp_is_shiny(pid, tsv)){
         pid ^= 0x10000000;
     }
 }
-//  Rebuild the PID so that it is shiny against the player's own TSV, in the same
-//  way (star vs. square) that it was shiny against the rolled TSV.
+
 static void force_shiny(uint32_t& pid, uint16_t tsv, BdspShiny shiny){
     if (bdsp_get_shiny(pid, tsv) == shiny){
         return;
@@ -194,9 +179,6 @@ static void force_shiny(uint32_t& pid, uint16_t tsv, BdspShiny shiny){
     pid = ((uint32_t)high << 16) | (pid & 0xffff);
 }
 
-//  The encounter rolls its own TSV, decides shininess against that, and only then
-//  is the PID reshaped to produce the same outcome against the player's real TSV.
-//  This is why a shiny frame stays shiny no matter whose save file is used.
 static BdspShiny resolve_shiny(uint32_t& pid, uint32_t sidtid, uint16_t tsv, bool shiny_locked){
     if (shiny_locked){
         force_not_shiny(pid, tsv);
@@ -227,8 +209,6 @@ static BdspPokemonResult generate_static_impl(
 
     result.shiny = resolve_shiny(result.pid, sidtid, tsv, tmpl.shiny_locked);
 
-    //  Guaranteed perfect IVs first. The roll picks a slot and is rerolled if that
-    //  slot is already taken, so the number of calls here is not fixed.
     const uint8_t UNSET = 255;
     BdspIVs ivs;
     for (size_t c = 0; c < 6; c++){
@@ -280,8 +260,7 @@ static BdspPokemonResult generate_static_impl(
         break;
     }
 
-    //  A Synchronize lead skips the nature roll entirely rather than overriding
-    //  its result, so it shifts everything after it.
+    //  A Synchronize lead skips the nature roll, so it shifts everything after it
     result.nature = synchronize_nature != BDSP_NO_SYNCHRONIZE
         ? synchronize_nature
         : (uint8_t)source.next(25);
@@ -309,16 +288,13 @@ BdspPokemonResult bdsp_generate_roamer(
     BdspPokemonResult result;
     result.level = tmpl.level;
 
-    //  A roamer takes exactly one value from the main RNG. Everything else comes
-    //  from a Xoroshiro seeded with it, which is why roamers cost one advance
-    //  regardless of how much they generate.
+    //  roamers cost one advance regardless of how much they generate.
     result.ec = bdsp_gen_transform(rng.next());
     XoroshiroBDSP roamer(result.ec);
 
     uint32_t sidtid = roamer.next_uint(0xffffffff);
     result.pid = roamer.next_uint(0xffffffff);
 
-    //  Both roamers (Cresselia, Mesprit) are shiny-capable.
     result.shiny = resolve_shiny(result.pid, sidtid, tsv, false);
 
     const uint8_t UNSET = 255;
@@ -340,8 +316,7 @@ BdspPokemonResult bdsp_generate_roamer(
     }
     result.ivs = ivs;
 
-    //  Neither roamer can have a hidden ability, so this path has no equivalent of
-    //  the ability_kind switch above.
+    //  Neither roamer can have a hidden ability
     result.ability = (uint8_t)roamer.next_uint(2);
 
     result.nature = synchronize_nature != BDSP_NO_SYNCHRONIZE
@@ -353,7 +328,7 @@ BdspPokemonResult bdsp_generate_roamer(
     result.weight = (uint8_t)roamer.next_uint(129);
     result.weight += (uint8_t)roamer.next_uint(128);
 
-    //  Roamer gender is fixed per species and is never rolled.
+    //  Roamer gender is never rolled
     result.gender = tmpl.gender_ratio == 254
         ? BdspGender::Female
         : BdspGender::Genderless;
@@ -385,10 +360,6 @@ BdspIdResult bdsp_generate_id(Xorshift128 rng){
 
 
 
-//
-//  Filtering and searching
-//
-
 static bool iv_in_range(const IvRange& range, uint8_t iv){
     if (range.low >= 0 && iv < (uint8_t)range.low){
         return false;
@@ -433,8 +404,7 @@ std::vector<BdspRngHit> BdspStaticSearcher::scan(
     Xorshift128 rng(m_base_state);
     rng.advance(min_advances);
 
-    //  A roamer reseeds a Xoroshiro on every advance, so there is nothing to
-    //  cache and the sliding window would only get in the way.
+    //  A roamer reseeds a Xoroshiro on every advance
     if (m_template.roamer){
         for (uint64_t advances = min_advances; advances <= max_advances; advances++){
             if (cancellable != nullptr && (advances % CANCEL_CHECK_INTERVAL) == 0){

SerialPrograms/Source/Pokemon/Pokemon_BdspRng.h

@@ -1,19 +1,7 @@
 /*  BDSP RNG
  *
  *  From: https://github.com/PokemonAutomation/
- *
- *  Pokemon generation for Brilliant Diamond / Shining Pearl, ported from
- *  PokeFinder's Gen 8 generators.
- *
- *  The main game RNG is xorshift128 (see Pokemon_Xorshift128.h). Most values are
- *  read through bdsp_gen_transform(). Some encounters then seed a separate
- *  Xoroshiro128+ from a single xorshift128 output and generate everything else
- *  from that.
- *
- *  Only the static/roamer and trainer-ID paths are implemented. Wild and egg
- *  generation additionally need per-species data and encounter tables, which
- *  this project does not have for BDSP yet.
- *
+ * 
  */
 
 #ifndef PokemonAutomation_Pokemon_BdspRng_H
@@ -34,21 +22,13 @@ namespace PokemonAutomation{
 namespace Pokemon{
 
 
-//
-//  Xoroshiro128+, BDSP flavor
-//
-
 uint64_t bdsp_splitmix64(uint64_t seed);
 
-//  Sign-extend a 32-bit RNG output to 64 bits. Egg generation does this before
-//  seeding; roamer generation does not.
+
 inline uint64_t bdsp_sign_extend_seed(uint32_t seed){
     return (uint64_t)(int64_t)(int32_t)seed;
 }
 
-//  Same core as Xoroshiro128Plus, but seeded through splitmix and bounded
-//  differently. Do not substitute Xoroshiro128Plus::nextInt() here: it uses
-//  power-of-two rejection sampling, which is what Sword/Shield does, not BDSP.
 class XoroshiroBDSP{
 public:
     explicit XoroshiroBDSP(uint64_t seed);
@@ -61,11 +41,6 @@ class XoroshiroBDSP{
 };
 
 
-
-//
-//  Results
-//
-
 enum class BdspShiny : uint8_t{
     None = 0,
     Star = 1,
@@ -81,9 +56,6 @@ enum class BdspGender : uint8_t{
 const char* bdsp_gender_name(BdspGender gender);
 
 struct BdspIVs{
-    //  BDSP's order, which is also PokeFinder's: HP, Atk, Def, SpA, SpD, Spe.
-    //  This is NOT the Gen 3 order used by AdvIVs in Pokemon_AdvRng.h, which puts
-    //  Speed at index 3. Do not unify them.
     uint8_t hp = 0;
     uint8_t attack = 0;
     uint8_t defense = 0;
@@ -116,59 +88,33 @@ struct BdspIdResult{
     uint32_t sidtid = 0;
     uint16_t tid = 0;
     uint16_t sid = 0;
-    //  The 6-digit number the trainer card shows under "ID No.". Derived from the
-    //  whole 32-bit draw, so it is neither the TID nor the SID.
     uint32_t display_tid = 0;
 
     uint16_t tsv() const{ return (uint16_t)(tid ^ sid); }
     std::string to_string() const;
 };
 
 
-//  Natures are indexed in the game's own order (0 = Hardy), which is not the
-//  order of NatureCheckerValue. Convert before comparing against anything from
-//  the UI or from an IV/nature reader.
 const char* bdsp_nature_name(uint8_t nature);
 NatureCheckerValue bdsp_nature_to_checker_value(uint8_t nature);
 
-//  psv == tsv is a square shiny; a difference under 16 is a star.
+//  psv == tsv is a square shiny; a difference under 16 is a star
 BdspShiny bdsp_get_shiny(uint32_t pid, uint16_t tsv);
 bool bdsp_is_shiny(uint32_t pid, uint16_t tsv);
 
 
-
-//
-//  Generation
-//
-
-//  Passed as "synchronize_nature" when no Synchronize lead is active.
 const uint8_t BDSP_NO_SYNCHRONIZE = 0xff;
 
 struct BdspStaticTemplate{
     std::string species;
     uint8_t level = 1;
-
-    //  How many IVs are forced to 31 before the rest are rolled.
     uint8_t guaranteed_ivs = 0;
-
-    //  0 or 1 forces that ability slot. 2 is the hidden ability, which still
-    //  burns one roll. 3 rolls between the two normal abilities.
     uint8_t ability_kind = 3;
-
-    //  255 = genderless, 254 = always female, 0 = always male. Otherwise a roll
-    //  must come in under this value to be female.
     uint8_t gender_ratio = 255;
-
-    //  Shiny-locked encounters still roll a PID, then force it non-shiny.
     bool shiny_locked = false;
-
-    //  Roamers (Cresselia, Mesprit) take one value from the main RNG as the EC,
-    //  then generate everything else from a Xoroshiro seeded with it.
     bool roamer = false;
 };
 
-//  Each of these takes the generator positioned at the target advance. The copy
-//  is deliberate: callers keep their own position.
 BdspPokemonResult bdsp_generate_static(
     Xorshift128 rng, const BdspStaticTemplate& tmpl,
     uint16_t tsv, uint8_t synchronize_nature = BDSP_NO_SYNCHRONIZE
@@ -177,7 +123,6 @@ BdspPokemonResult bdsp_generate_roamer(
     Xorshift128 rng, const BdspStaticTemplate& tmpl,
     uint16_t tsv, uint8_t synchronize_nature = BDSP_NO_SYNCHRONIZE
 );
-//  Dispatches on tmpl.roamer.
 BdspPokemonResult bdsp_generate(
     Xorshift128 rng, const BdspStaticTemplate& tmpl,
     uint16_t tsv, uint8_t synchronize_nature = BDSP_NO_SYNCHRONIZE
@@ -186,11 +131,6 @@ BdspPokemonResult bdsp_generate(
 BdspIdResult bdsp_generate_id(Xorshift128 rng);
 
 
-
-//
-//  Filtering and searching
-//
-
 struct BdspRngHit{
     uint64_t advances = 0;
     Xorshift128State state;
@@ -209,20 +149,8 @@ class BdspStaticSearcher{
 
     const BdspStaticTemplate& pokemon_template() const{ return m_template; }
 
-    //  The Pokemon produced "advances" steps after the base state.
-    //
-    //  This jumps from the base state on every call, which is the right thing for one
-    //  advance and the wrong thing for a range: use scan() to sweep one, or the cost
-    //  is a fresh jump per advance rather than a single step.
     BdspPokemonResult generate(uint64_t advances) const;
 
-    //  Every advance in [min_advances, max_advances] that "accept" accepts, earliest
-    //  first, or just the first of them if "stop_at_first".
-    //
-    //  Walks forward one advance at a time through a sliding window, so sweeping a
-    //  whole search window costs about what a single generate() does. The predicate
-    //  is the caller's because programs filter through the shared UI tables, and a
-    //  second filter type here would only be those tables written out twice.
     std::vector<BdspRngHit> scan(
         uint64_t min_advances, uint64_t max_advances,
         const std::function<bool(const BdspPokemonResult&)>& accept,