tweak method timing restrictions

Author: bhaller

VERSIONS

@@ -194,6 +194,7 @@ multitrait branch:
 	did a full re-architecture of how mutations get "retained by the tree sequence" to fix remaining issues:
 		fix #646: saved mutations can be added later and bypass retained_by_treeseq_
 		fix #648: saving without simplification results in mutations without metadata
+	tweak timing restrictions to allow some methods -- notably demandPhenotype() -- to be called from the Eidos console in SLiMgui
 
 
 version 5.2 (Eidos version 4.2):

core/community_eidos.cpp

@@ -193,8 +193,14 @@ EidosSymbolTable *Community::SymbolsFromBaseSymbols(EidosSymbolTable *p_base_sym
 
 void Community::EnforceTimingRestriction_EventBlockOnly(const char *p_method_name, const char *p_eidos_name, const char *p_addendum)
 {
+	SLiMCycleStage cycle_stage = CycleStage();
+	
 	// TIMING RESTRICTION
 	// must be called directly from an event block -- not from a callback, even if the callback was triggered inside the event block
+	// BCH 7/21/2026: It is now also legal to call a method with this restriction from the Eidos console in SLiMgui; that is very similar to an event.
+	if ((cycle_stage == SLiMCycleStage::kStagePostCycle) && (executing_block_type_ == SLiMEidosBlockType::SLiMEidosNoBlockType))
+		return;
+	
 	if ((executing_block_type_ != SLiMEidosBlockType::SLiMEidosEventFirst) && (executing_block_type_ != SLiMEidosBlockType::SLiMEidosEventEarly) && (executing_block_type_ != SLiMEidosBlockType::SLiMEidosEventLate))
 		EIDOS_TERMINATION << "ERROR (" << p_method_name << "): " << p_eidos_name << " must be called directly from a first(), early(), or late() event" << p_addendum << "." << EidosTerminate();
 }

core/individual.cpp

@@ -7408,10 +7408,11 @@ void Individual_Class::DemandPhenotype_INDIVIDUALS(Species *species, Individual
 	// ploidy and callbacks as needed.  It is very nice to have the top-level loop be over the chromosomes,
 	// so that each one can do a single timing for mutrun experiments.
 	int haplosome_index = 0;
+	bool local_doing_mutrun_experiments = species->DoingAnyMutationRunExperiments();
 
 	for (Chromosome *chromosome : species->Chromosomes())
 	{
-		if (species->DoingAnyMutationRunExperiments())
+		if (local_doing_mutrun_experiments)
 			chromosome->StartMutationRunExperimentClock();
 
 		switch (chromosome->Type())
@@ -7562,7 +7563,7 @@ void Individual_Class::DemandPhenotype_INDIVIDUALS(Species *species, Individual
 			}
 		}
 
-		if (species->DoingAnyMutationRunExperiments())
+		if (local_doing_mutrun_experiments)
 			chromosome->StopMutationRunExperimentClock("DemandPhenotype_INDIVIDUALS()");
 
 		haplosome_index += chromosome->IntrinsicPloidy();
@@ -7866,10 +7867,11 @@ void Individual_Class::DemandPhenotype_SUBPOP(Species *species, Subpopulation *s
 	// ploidy and callbacks as needed.  It is very nice to have the top-level loop be over the chromosomes,
 	// so that each one can do a single timing for mutrun experiments.
 	int haplosome_index = 0;
+	bool local_doing_mutrun_experiments = species->DoingAnyMutationRunExperiments();
 
 	for (Chromosome *chromosome : species->Chromosomes())
 	{
-		if (species->DoingAnyMutationRunExperiments())
+		if (local_doing_mutrun_experiments)
 			chromosome->StartMutationRunExperimentClock();
 
 		for (int trait_indices_index = 0; trait_indices_index < trait_indices_count; trait_indices_index++)
@@ -8219,7 +8221,7 @@ void Individual_Class::DemandPhenotype_SUBPOP(Species *species, Subpopulation *s
 			}
 		}
 
-		if (species->DoingAnyMutationRunExperiments())
+		if (local_doing_mutrun_experiments)
 			chromosome->StopMutationRunExperimentClock("DemandPhenotype_SUBPOP()");
 
 		haplosome_index += chromosome->IntrinsicPloidy();

core/population.cpp

@@ -1303,13 +1303,15 @@ void Population::EvolveSubpopulation(Subpopulation &p_subpop, bool p_mate_choice
 	bool recording_tree_sequence = species_.RecordingTreeSequence();
 	bool has_munge_callback = (p_modify_child_callbacks_present || p_recombination_callbacks_present || p_mutation_callbacks_present);
 	bool is_spatial = (species_.SpatialDimensionality() >= 1);
-	bool mutrun_exp_timing_per_individual = species_.DoingAnyMutationRunExperiments() && (species_.Chromosomes().size() > 1);
+	bool local_doing_mutrun_experiments = species_.DoingAnyMutationRunExperiments();
+	bool do_mutrun_exp_timing_per_individual = local_doing_mutrun_experiments && (species_.Chromosomes().size() > 1);
+	bool do_mutrun_exp_timing_once = local_doing_mutrun_experiments && (species_.Chromosomes().size() == 1);
 
 	bool (Subpopulation::*MungeIndividualCrossed_TEMPLATED)(Individual *individual, slim_pedigreeid_t p_pedigree_id, Individual *p_parent1, Individual *p_parent2, IndividualSex p_child_sex);
 	bool (Subpopulation::*MungeIndividualSelfed_TEMPLATED)(Individual *individual, slim_pedigreeid_t p_pedigree_id, Individual *p_parent);
 	bool (Subpopulation::*MungeIndividualCloned_TEMPLATED)(Individual *individual, slim_pedigreeid_t p_pedigree_id, Individual *p_parent);
 
-	if (mutrun_exp_timing_per_individual)
+	if (do_mutrun_exp_timing_per_individual)
 	{
 		if (pedigrees_enabled)
 		{
@@ -1593,7 +1595,7 @@ void Population::EvolveSubpopulation(Subpopulation &p_subpop, bool p_mate_choice
 	}
 
 	// refine the above choice with a custom version of optimizations for simple "A" and "H" cases
-	if (!mutrun_exp_timing_per_individual && !has_munge_callback && (species_.Chromosomes().size() == 1))
+	if (!do_mutrun_exp_timing_per_individual && !has_munge_callback && (species_.Chromosomes().size() == 1))
 	{
 		Chromosome *chromosome = species_.Chromosomes()[0];
 		ChromosomeType chromosome_type = chromosome->Type();
@@ -1807,7 +1809,7 @@ void Population::EvolveSubpopulation(Subpopulation &p_subpop, bool p_mate_choice
 	// are various ways that could potentially be cut down.  (a) not measure in every tick, (b) stop measuring
 	// once you've settled down into stasis, (c) measure a subset of all reproductions.  This should be done in
 	// future, but we're out of time for now.
-	if (species_.DoingAnyMutationRunExperiments() && (species_.Chromosomes().size() == 1))
+	if (do_mutrun_exp_timing_once)
 		species_.Chromosomes()[0]->StartMutationRunExperimentClock();
 
 	if (p_mate_choice_callbacks_present || p_modify_child_callbacks_present || p_recombination_callbacks_present || p_mutation_callbacks_present || p_type_s_DES_present)
@@ -2746,7 +2748,7 @@ void Population::EvolveSubpopulation(Subpopulation &p_subpop, bool p_mate_choice
 	// Mutrun experiment timing can be per-individual, per-chromosome, but that entails a lot of timing overhead.
 	// To avoid that overhead, in single-chromosome models we just time across the whole round of reproduction
 	// instead.  Note that in this case we chose a template above for the Munge...() methods that does not time.
-	if (species_.DoingAnyMutationRunExperiments() && (species_.Chromosomes().size() == 1))
+	if (do_mutrun_exp_timing_once)
 		species_.Chromosomes()[0]->StopMutationRunExperimentClock("EvolveSubpopulation()");
 }
 

core/species.cpp

@@ -1723,6 +1723,7 @@ void Species::_ValidateNonNeutralCaches(const std::vector<slim_trait_index_t> &p
 	MutationBlock *mutation_block = mutation_block_;
 	Mutation *mut_block_ptr = mutation_block->mutation_buffer_;
 	const std::map<slim_objectid_t,MutationType*> &mut_types = MutationTypes();
+	bool local_doing_mutrun_experiments = DoingAnyMutationRunExperiments();
 
 	for (Chromosome *chromosome : chromosomes_)
 	{
@@ -1888,7 +1889,7 @@ void Species::_ValidateNonNeutralCaches(const std::vector<slim_trait_index_t> &p
 		int64_t mutations_cached = 0, mutations_omitted = 0, mutations_summarized = 0;
 #endif
 
-		if (DoingAnyMutationRunExperiments()) chromosome->StartMutationRunExperimentClock();
+		if (local_doing_mutrun_experiments) chromosome->StartMutationRunExperimentClock();
 
 		int mutrun_context_count = chromosome->ChromosomeMutationRunContextCount();
 
@@ -2077,7 +2078,7 @@ void Species::_ValidateNonNeutralCaches(const std::vector<slim_trait_index_t> &p
 #endif
 		}
 
-		if (DoingAnyMutationRunExperiments()) chromosome->StopMutationRunExperimentClock("ValidateNonNeutralCaches()");
+		if (local_doing_mutrun_experiments) chromosome->StopMutationRunExperimentClock("ValidateNonNeutralCaches()");
 
 #if SLIM_PROFILE_NONNEUTRAL_CACHES()
 		// FIXME MULTITRAIT: would be nice to use total_run_count in the profile output too!
@@ -5346,8 +5347,6 @@ void Species::MaintainTreeSequence(void)
 void Species::EmptyGraveyard(void)
 {
 	// Individuals end up in graveyard_ due to killIndividuals(); they get disposed of here.
-	// It's not necessary that FreeSubpopIndividual() be called on the correct subpopulation, really,
-	// but that API is at the Subpopulation level instead of in Species for efficiency, so...
 	for (Individual *individual : graveyard_)
 		individual->subpopulation_->FreeSubpopIndividual(individual);
 
@@ -5518,8 +5517,9 @@ void Species::nonWF_GenerateOffspring(void)
 	bool recording_tree_sequence = RecordingTreeSequence();
 	bool has_callbacks = ((reproduction_callbacks.size() > 0) || (modify_child_callbacks.size() > 0) || (recombination_callbacks.size() > 0) || (mutation_callbacks.size() > 0));
 	bool is_spatial = (SpatialDimensionality() >= 1);
+	bool local_doing_mutrun_experiments = DoingAnyMutationRunExperiments();
 
-	if (DoingAnyMutationRunExperiments())
+	if (local_doing_mutrun_experiments)
 	{
 		if (pedigrees_enabled)
 		{
@@ -6005,6 +6005,17 @@ void Species::nonWF_ViabilitySurvival(void)
 	population_.InvalidateMutationReferencesCache();
 }
 
+bool Species::DoingAnyMutationRunExperiments(void) const
+{
+	// BCH 7/21/2026: We want to allow some operations to be done in the Eidos console that would normally
+	// be measured for mutrun experiments, so here we disable mutrun experiments when between ticks.
+	// NOTE: For this reason, doing_any_mutrun_experiments_ should not be consulted directly!
+	if (community_.CycleStage() == SLiMCycleStage::kStagePostCycle)
+		return false;
+	
+	return doing_any_mutrun_experiments_;
+}
+
 void Species::FinishMutationRunExperimentTimings(void)
 {
 	for (Chromosome *chromosome : chromosomes_)

core/species.h

@@ -327,7 +327,7 @@ class Species : public EidosDictionaryUnretained
 
 	// mutation run timing experiment configuration
 	bool do_mutrun_experiments_ = true;				// user-level flag in initializeSLiMOptions(); if false, experiments are never run
-	bool doing_any_mutrun_experiments_ = false;		// is any chromosome actually running mutation run timing experiments?
+	bool doing_any_mutrun_experiments_ = false;		// is any chromosome actually running mutation run timing experiments?  DO NOT USE DIRECTLY!
 
 	// nucleotide-based models
 	bool nucleotide_based_ = false;
@@ -709,7 +709,7 @@ class Species : public EidosDictionaryUnretained
 
 	inline __attribute__((always_inline)) bool UserWantsMutrunExperiments(void) const										{ return do_mutrun_experiments_; }
 	inline __attribute__((always_inline)) void DoingMutrunExperimentsForChromosome(void)									{ doing_any_mutrun_experiments_ = true; }
-	inline __attribute__((always_inline)) bool DoingAnyMutationRunExperiments(void) const									{ return doing_any_mutrun_experiments_; }
+	bool DoingAnyMutationRunExperiments(void) const;
 
 	inline __attribute__((always_inline)) bool IsNucleotideBased(void) const												{ return nucleotide_based_; }
 

core/subpopulation.cpp

@@ -10555,7 +10555,7 @@ EidosValue_SP Subpopulation::ExecuteMethod_removeSubpopulation(EidosGlobalString
 
 	// TIMING RESTRICTION
 	if (community_.executing_species_ == &species_)
-		community_.EnforceTimingRestriction_EventBlockOnly("Subpopulation::ExecuteMethod_removeSubpopulation", "removeSubpopulation()", "");
+		community_.EnforceTimingRestriction_EventBlockOnly("Subpopulation::ExecuteMethod_removeSubpopulation", "removeSubpopulation()", ", when called on the currently executing species");
 
 	population_.RemoveSubpopulation(*this);