PKHeX/PKHeX.Core/Legality/Evolutions/EvoCriteria.cs

namespace PKHeX.Core;

public readonly record struct EvoCriteria
{
    public ushort Species { get; init; }
    public byte Form { get; init; }
    public byte LevelUpRequired { get; init; }
    public byte LevelMax { get; init; }
    public byte LevelMin { get; init; }

    public EvolutionType Method { get; init; }

    public bool RequiresLvlUp => LevelUpRequired != 0;

    public bool InsideLevelRange(int level) => LevelMin <= level && level <= LevelMax;

    public override string ToString() => $"{(Species) Species}{(Form != 0 ? $"-{Form}" : "")}}} [{LevelMin},{LevelMax}] via {Method}";
}
Refactoring: Move Source (Legality) (#3560) Rewrites a good amount of legality APIs pertaining to: * Legal moves that can be learned * Evolution chains & cross-generation paths * Memory validation with forgotten moves In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data. The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space. The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation. * `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game. * `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`). * Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable 2022-08-03 23:15:27 +00:00			`namespace PKHeX.Core;`
Clean up dexlevel/evocriteria constructor usage DexLevel was the initial abstraction, which was expanded/reused for evolution details I should probably merge the two classes since everything is passed as EvoCriteria The encounter generators do some silly form fuzzy match which can now be more accurately checked since I've moved Form to DexLevel... maybe a future commit can clean that up. encounterarea2 was reusing this class, just use a throwaway readonly struct as our temp value storage 2019-12-06 07:04:24 +00:00
Eliminate boxing on encounter search (criteria) struct implementing interface is boxed when passed to method that accepts interface (not generic method). Removes IDexLevel (no other inheritors but EvoCriteria) and uses the primitive the data is stored (array, not IReadOnlyList) for slightly better perf. 2022-05-08 01:29:36 +00:00			`public readonly record struct EvoCriteria`
Remove EvoBase, relocate functions to call sites Utilize FormInfo to remap battle forms into hatch forms so the encounter matches something valid, and is flagged later in FormVerifier 2021-12-26 08:57:40 +00:00			`{`
Refactor EvoCriteria to be a struct, reduce allocation (#3483) * Make EvolutionCriteria struct 8 bytes per object instead of 26 Unify LevelMin/LevelMax to match EncounterTemplate bubble up precise array type for better iteration * Inline queue operations, less allocation * Inline some logic * Update EvolutionChain.cs * Improve clarity on duplicate move check * Search reverse For a dual stage chain, finds it first iteration rather than second. 2022-04-24 04:33:17 +00:00			`public ushort Species { get; init; }`
			`public byte Form { get; init; }`
			`public byte LevelUpRequired { get; init; }`
			`public byte LevelMax { get; init; }`
			`public byte LevelMin { get; init; }`
Misc updates reducing allocations, increasing clarity by removing some magic numbers probably can rewrite some of the evo loading/checking for even less, but good for now. 2019-01-07 00:22:45 +00:00
Refactor EvoCriteria to be a struct, reduce allocation (#3483) * Make EvolutionCriteria struct 8 bytes per object instead of 26 Unify LevelMin/LevelMax to match EncounterTemplate bubble up precise array type for better iteration * Inline queue operations, less allocation * Inline some logic * Update EvolutionChain.cs * Improve clarity on duplicate move check * Search reverse For a dual stage chain, finds it first iteration rather than second. 2022-04-24 04:33:17 +00:00			`public EvolutionType Method { get; init; }`
Finish splitting gen1/2 encounter types from parent class Results in a little more code, but each path is less tangled simplify some expressions remove RBDragonair content in favor of a strict filter for catch rate Move gen1 trade trainer names to stringconverter, since pk1/pk2 shouldn't refer to legality classes 2020-07-19 18:32:40 +00:00
Refactor EvoCriteria to be a struct, reduce allocation (#3483) * Make EvolutionCriteria struct 8 bytes per object instead of 26 Unify LevelMin/LevelMax to match EncounterTemplate bubble up precise array type for better iteration * Inline queue operations, less allocation * Inline some logic * Update EvolutionChain.cs * Improve clarity on duplicate move check * Search reverse For a dual stage chain, finds it first iteration rather than second. 2022-04-24 04:33:17 +00:00			`public bool RequiresLvlUp => LevelUpRequired != 0;`

Refactoring: Move Source (Legality) (#3560) Rewrites a good amount of legality APIs pertaining to: * Legal moves that can be learned * Evolution chains & cross-generation paths * Memory validation with forgotten moves In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data. The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space. The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation. * `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game. * `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`). * Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable 2022-08-03 23:15:27 +00:00			`public bool InsideLevelRange(int level) => LevelMin <= level && level <= LevelMax;`

Refactor EvoCriteria to be a struct, reduce allocation (#3483) * Make EvolutionCriteria struct 8 bytes per object instead of 26 Unify LevelMin/LevelMax to match EncounterTemplate bubble up precise array type for better iteration * Inline queue operations, less allocation * Inline some logic * Update EvolutionChain.cs * Improve clarity on duplicate move check * Search reverse For a dual stage chain, finds it first iteration rather than second. 2022-04-24 04:33:17 +00:00			`public override string ToString() => $"{(Species) Species}{(Form != 0 ? $"-{Form}" : "")}}} [{LevelMin},{LevelMax}] via {Method}";`
Refactoring Split evolution data specific DexLevel properties from DexLevel use IReadOnlyList instead of IList for covariant collection 2018-06-19 02:10:21 +00:00			`}`