tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): added more callback docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-07-31 15:41:27 -04:00
parent 24049b2658
commit b0c1daada4
30 changed files with 371 additions and 329 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/html/search/all_a.js
View File

@@ -32,7 +32,7 @@ var searchData=
['engineerrortypes_29',['EngineErrorTypes',['../namespacegridfire_1_1expectations.html#a926cb0409b1f38770eb028bcac70a87c',1,'gridfire::expectations']]],
['engineindexerror_30',['EngineIndexError',['../structgridfire_1_1expectations_1_1_engine_index_error.html',1,'gridfire::expectations::EngineIndexError'],['../structgridfire_1_1expectations_1_1_engine_index_error.html#ab44bba2a197d43319e65cd200cd347b0',1,'gridfire::expectations::EngineIndexError::EngineIndexError()']]],
['engines_31',['Engines',['../engine_8h.html#AvailableEngines',1,'Available Engines'],['../index.html#autotoc_md28',1,'Engines']]],
['engines_20and_20views_32',['2. Why These Engines and Views?',['../md_docs_2static_2usage.html#autotoc_md63',1,'']]],
['engines_20and_20views_32',['2. Why These Engines and Views?',['../md_docs_2static_2usage.html#autotoc_md64',1,'']]],
['enginet_20gt_20_3a_33',['NetworkSolverStrategy<EngineT>:',['../index.html#autotoc_md37',1,'']]],
['enginetype_34',['EngineType',['../conceptgridfire_1_1_engine_type.html',1,'gridfire']]],
['engineview_35',['EngineView',['../classgridfire_1_1_engine_view.html',1,'gridfire']]],
@@ -43,14 +43,13 @@ var searchData=
['error_5fengine_2eh_40',['error_engine.h',['../error__engine_8h.html',1,'']]],
['evaluate_41',['evaluate',['../classgridfire_1_1approx8_1_1_approx8_network.html#a888734a3cdde4259e921e2efece411ee',1,'gridfire::approx8::Approx8Network::evaluate()'],['../classgridfire_1_1_network.html#afc8d5172dd0e2295248b42dcb52b655c',1,'gridfire::Network::evaluate()'],['../classgridfire_1_1partition_1_1_composite_partition_function.html#a8d6d278fcb5b8478b0e27535f877ee2b',1,'gridfire::partition::CompositePartitionFunction::evaluate()'],['../classgridfire_1_1partition_1_1_partition_function.html#a08ee79b7d8723b4e00ee1fc9cdfbe817',1,'gridfire::partition::PartitionFunction::evaluate()'],['../classgridfire_1_1partition_1_1_ground_state_partition_function.html#af16da0015489307eb64639efbafbbdd5',1,'gridfire::partition::GroundStatePartitionFunction::evaluate()'],['../classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#aebe49d06b50a18ea4484ff15cb301681',1,'gridfire::partition::RauscherThielemannPartitionFunction::evaluate()'],['../classgridfire_1_1solver_1_1_network_solver_strategy.html#ace539b0482db171845ff1bd38d76b70f',1,'gridfire::solver::NetworkSolverStrategy::evaluate()'],['../classgridfire_1_1solver_1_1_direct_network_solver.html#a0e8a4b8ef656e0b084d11bea982e412a',1,'gridfire::solver::DirectNetworkSolver::evaluate()'],['../class_py_partition_function.html#a83aca0bc261734b7d3df8269f730c69b',1,'PyPartitionFunction::evaluate()'],['../class_py_dynamic_network_solver_strategy.html#a2095abb83ed6229ebb27b4883cec51c4',1,'PyDynamicNetworkSolverStrategy::evaluate()']]],
['evaluatederivative_42',['evaluateDerivative',['../classgridfire_1_1partition_1_1_composite_partition_function.html#ac8900afaa5edd24fcb8eaf19e7379183',1,'gridfire::partition::CompositePartitionFunction::evaluateDerivative()'],['../classgridfire_1_1partition_1_1_partition_function.html#a14009bdaca47f3eddf2c6c023845db5a',1,'gridfire::partition::PartitionFunction::evaluateDerivative()'],['../classgridfire_1_1partition_1_1_ground_state_partition_function.html#a0eff10c7b134d9d4081ad72bbc785c5b',1,'gridfire::partition::GroundStatePartitionFunction::evaluateDerivative()'],['../classgridfire_1_1partition_1_1_rauscher_thielemann_partition_function.html#aaa1e11579b44a88c5f18943cc303c4b4',1,'gridfire::partition::RauscherThielemannPartitionFunction::evaluateDerivative()'],['../class_py_partition_function.html#a260df9689bf698970ebf5104977a3dcf',1,'PyPartitionFunction::evaluateDerivative()']]],
['examople_43',['Common Workflow Examople',['../index.html#autotoc_md54',1,'']]],
['example_44',['Example',['../md_docs_2static_2usage.html#autotoc_md65',1,'3. Step-by-Step Example'],['../engine_8h.html#AdaptiveEngineViewExample',1,'AdaptiveEngineView Example'],['../index.html#autotoc_md52',1,'Callback Example'],['../index.html#autotoc_md50',1,'Common Workflow Example'],['../engine_8h.html#DefinedEngineViewExample',1,'DefinedEngineView Example'],['../engine_8h.html#GraphEngineExample',1,'GraphEngine Example'],['../engine_8h.html#MultiscalePartitioningEngineViewExample',1,'MultiscalePartitioningEngineView Example'],['../engine_8h.html#NetworkPrimingEngineViewExample',1,'NetworkPrimingEngineView Example']]],
['examples_45',['Examples',['../index.html#autotoc_md18',1,'Examples'],['../engine_8h.html#UsageExamples',1,'Usage Examples'],['../index.html#autotoc_md45',1,'Usage Examples']]],
['exceptions_2eh_46',['exceptions.h',['../exceptions_8h.html',1,'']]],
['excess_5fenergy_47',['excess_energy',['../classgridfire_1_1reaction_1_1_reaction.html#aa1d71e38fc55ae691dbb9ec459a612a5',1,'gridfire::reaction::Reaction::excess_energy()'],['../classgridfire_1_1_reaction.html#aa1d71e38fc55ae691dbb9ec459a612a5',1,'gridfire::Reaction::excess_energy()']]],
['expectations_2eh_48',['expectations.h',['../expectations_8h.html',1,'']]],
['expected_5fengine_2eh_49',['expected_engine.h',['../expected__engine_8h.html',1,'']]],
['exporttocsv_50',['exportToCSV',['../classgridfire_1_1_graph_engine.html#a832e2fe066381811a3e0464806ff5e95',1,'gridfire::GraphEngine']]],
['exporttodot_51',['exportToDot',['../classgridfire_1_1_graph_engine.html#adac8c7d62bae76e17fc060e86dadd929',1,'gridfire::GraphEngine::exportToDot()'],['../classgridfire_1_1_multiscale_partitioning_engine_view.html#acff59a15abac30eee16e9fa7b355fb18',1,'gridfire::MultiscalePartitioningEngineView::exportToDot()']]],
['extensibility_52',['Python Extensibility',['../index.html#autotoc_md44',1,'']]]
['example_43',['Example',['../md_docs_2static_2usage.html#autotoc_md66',1,'3. Step-by-Step Example'],['../engine_8h.html#AdaptiveEngineViewExample',1,'AdaptiveEngineView Example'],['../index.html#autotoc_md52',1,'Callback Example'],['../index.html#autotoc_md50',1,'Common Workflow Example'],['../index.html#autotoc_md55',1,'Common Workflow Example'],['../engine_8h.html#DefinedEngineViewExample',1,'DefinedEngineView Example'],['../engine_8h.html#GraphEngineExample',1,'GraphEngine Example'],['../engine_8h.html#MultiscalePartitioningEngineViewExample',1,'MultiscalePartitioningEngineView Example'],['../engine_8h.html#NetworkPrimingEngineViewExample',1,'NetworkPrimingEngineView Example']]],
['examples_44',['Examples',['../index.html#autotoc_md18',1,'Examples'],['../engine_8h.html#UsageExamples',1,'Usage Examples'],['../index.html#autotoc_md45',1,'Usage Examples']]],
['exceptions_2eh_45',['exceptions.h',['../exceptions_8h.html',1,'']]],
['excess_5fenergy_46',['excess_energy',['../classgridfire_1_1reaction_1_1_reaction.html#aa1d71e38fc55ae691dbb9ec459a612a5',1,'gridfire::reaction::Reaction::excess_energy()'],['../classgridfire_1_1_reaction.html#aa1d71e38fc55ae691dbb9ec459a612a5',1,'gridfire::Reaction::excess_energy()']]],
['expectations_2eh_47',['expectations.h',['../expectations_8h.html',1,'']]],
['expected_5fengine_2eh_48',['expected_engine.h',['../expected__engine_8h.html',1,'']]],
['exporttocsv_49',['exportToCSV',['../classgridfire_1_1_graph_engine.html#a832e2fe066381811a3e0464806ff5e95',1,'gridfire::GraphEngine']]],
['exporttodot_50',['exportToDot',['../classgridfire_1_1_graph_engine.html#adac8c7d62bae76e17fc060e86dadd929',1,'gridfire::GraphEngine::exportToDot()'],['../classgridfire_1_1_multiscale_partitioning_engine_view.html#acff59a15abac30eee16e9fa7b355fb18',1,'gridfire::MultiscalePartitioningEngineView::exportToDot()']]],
['extensibility_51',['Python Extensibility',['../index.html#autotoc_md44',1,'']]]
];