AIM cache filter function once

[Brambor]

Summary

Performance "AIM cache filter function once"

Purpose of change

Fitler functions can be separated into two phases, preparation and run, example:

preparation

Cataclysm-DDA/src/item_search.cpp

Lines 92 to 106 in 52e00eb

	std::unordered_set<bodypart_id> filtered_bodyparts;
	std::unordered_set<sub_bodypart_id> filtered_sub_bodyparts;
	for( const body_part &bp : all_body_parts ) {
	const bodypart_str_id &bp_str_id = convert_bp( bp );
	if( lcmatch( body_part_name( bp_str_id, 1 ), filter )
	|| lcmatch( body_part_name( bp_str_id, 2 ), filter ) ) {
	filtered_bodyparts.insert( bp_str_id->id );
	}
	for( const sub_bodypart_str_id &sbp : bp_str_id->sub_parts ) {
	if( lcmatch( sbp->name.translated(), filter )
	|| lcmatch( sbp->name_multiple.translated(), filter ) ) {
	filtered_sub_bodyparts.insert( sbp->id );
	}
	}
	}

run

Cataclysm-DDA/src/item_search.cpp

Lines 107 to 115 in 52e00eb

	return [filtered_bodyparts, filtered_sub_bodyparts]( const item & i ) {
	return std::any_of( filtered_bodyparts.begin(), filtered_bodyparts.end(),
	[&i]( const bodypart_id & bp ) {
	return i.covers( bp );
	} )
	|| std::any_of( filtered_sub_bodyparts.begin(), filtered_sub_bodyparts.end(),
	[&i]( const sub_bodypart_id & sbp ) {
	return i.covers( sbp );
	} );

I thought it AIM executes the preparation once, but it does not. So I am making it so.

I want to do filter functions with expansive preparation like here #78384 but for AIM. Without this, the game slows down to a crawl.

Describe the solution

• I noticed that the current cache is really bad, maybe even non sensical, so I deleted it. It stored filter function for every item name. All the filters are identical.
  • It was originally added here V-menu style filters for advanced inventory menu. #11235. I don't know if it made sense back then, but it does not make sense now.
• Store the filter function only once.
• Prepare filter function on filter change, rather than asking every time if we have cache, just have them.
• Setters and getters for filter and make filter private. To find, fix and forbid future access to setting filter. Now filter is set only from set_filter and always updates the filter function.

Describe alternatives you've considered

Testing

• I did some performance testing. It has nearly no effect on performance (Took < ~1.2 % when moving all items). But it is about 20 times faster for my test.
  • Slow
  • Fast
• It has huge impact for the upcoming PR. In there, I prepare and catch exceptions.

The test is in this save
TEST AIM move.zip
Move the things through AIM with filters v:h on both panes.

To measure the performance, place breakpoint A here

Cataclysm-DDA/src/advanced_inv.cpp

Line 1012 in 52e00eb

advanced_inventory_pane &spane = panes[src];

breakpoint B here

Cataclysm-DDA/src/advanced_inv.cpp

Line 1912 in 52e00eb

const std::string action = is_processing() ? "MOVE_ALL_ITEMS" : ctxt.handle_input();

1. Load game.
2. Deactivate B. (Otherwise you will hit it by being in AIM).
3. Open AIM.
4. Initialize move all.
5. Observe: Game stops at breakpoint A.
6. Activate breakpoint B.
7. Continue the execution.
8. Observe: breakpoint B is hit.
9. Look at CPU profiling obtained between the breakpoints.

Additional context

I went through the View menu (Look around), it seems to do the preparation part only once.