Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

All groups for output #314

Merged
merged 5 commits into from
Oct 31, 2020
Merged

All groups for output #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ad41dce
Refactor handling of enums in inputs
jnthn Oct 30, 2020
38977f2
Provide a way to get all possible filter outputs
jnthn Oct 30, 2020
5753f56
Sort by keys
zaucker Oct 30, 2020
c0be941
Add --include-all-filters for text output
zaucker Oct 30, 2020
437fbcc
Sort modules on something more useful
jnthn Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/Agrammon/Model.pm6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ class Agrammon::Model {
$outputs.declare-multi-instance($tax);
for $input.inputs-list-for($tax) -> $multi-input {
my %filters := $!filter-set.filters-for($multi-input);
my $multi-output = $outputs.new-instance($tax, $multi-input.instance-id, :%filters);
my $multi-output = $outputs.new-instance($tax, $multi-input.instance-id, :%filters, :$!filter-set);
self!run-as-single($multi-input, %technical, $multi-output, %run-already.clone);
}
self!mark-multi-run(%run-already);
Expand Down
23 changes: 20 additions & 3 deletions lib/Agrammon/Model/FilterSet.pm6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,28 @@ class Agrammon::Model::FilterSet {
has Str $.taxonomy is required;
has Str $.input-name is required;
has Str $.filter-key = $!taxonomy ~ '::' ~ $!input-name;
has @.options is required;
}

has Filter @!filters;
has Agrammon::Model::Module $.module;

submethod BUILD(Agrammon::Model::Module :$module!, :@dependencies! --> Nil) {
self!add-from-module($module);
submethod BUILD(Agrammon::Model::Module :$!module!, :@dependencies! --> Nil) {
self!add-from-module($!module);
self!add-from-module($_) for @dependencies;
}

method !add-from-module(Agrammon::Model::Module $module --> Nil) {
for $module.input -> Agrammon::Model::Input $input {
if $input.is-filter {
@!filters.push: Filter.new: taxonomy => $module.taxonomy, input-name => $input.name;
my @enums := $input.enum-ordered;
unless @enums {
die "Filter input '$input.name()' in module '$module.taxonomy()' is not an enum type";
}
@!filters.push: Filter.new:
taxonomy => $module.taxonomy,
input-name => $input.name,
options => @enums;
}
}
}
Expand All @@ -38,4 +47,12 @@ class Agrammon::Model::FilterSet {
}
}
}

#| Get all possible filter key sets.
method all-possible-filter-keys(--> Sequence) {
my @combos = @!filters.map: -> Filter $filter {
[ $filter.filter-key <<=>>> $filter.options.map(*.key) ]
}
(@!filters == 1 ?? @combos[0] !! cross(@combos)).map(*.hash)
}
}
35 changes: 16 additions & 19 deletions lib/Agrammon/Model/Input.pm6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ class Agrammon::Model::Input {
has %.units;
has %.help;
has Str @.models;
# has Str @.options; # XXX set correct type: array of arrays
# has Str @.optionsLang; # XXX set correct type: array of hashes
has @.options; # XXX set correct type: array of arrays
has @.options-lang; # XXX set correct type: array of hashes
has @!enum-order;
has %!enum-lookup;
has Int $.order;
Expand All @@ -38,8 +34,8 @@ class Agrammon::Model::Input {
}
}
if @enum {
@!enum-order = @enum;
%!enum-lookup = @enum;
@!enum-order = @enum.map({ .key => self!parse-enum-lang-values(.value) });
%!enum-lookup = @!enum-order;
}
with $filter {
if .lc eq 'true' {
Expand All @@ -50,6 +46,8 @@ class Agrammon::Model::Input {

method enum(--> Hash) { %!enum-lookup }

method enum-ordered(--> Array) { @!enum-order }

method is-branch(--> Bool) { $!branch }

method is-filter(--> Bool) { $!filter }
Expand All @@ -73,19 +71,9 @@ class Agrammon::Model::Input {

for @!enum-order {
my $name = .key;
my $optLang = .value;
my $label = $name;
$label ~~ s:g/_/ /;
my @opt = [ $label, '', $name];
my @opt-lang = split("\n", $optLang);
my %opt-lang;
for @opt-lang -> $ol {
my ($l, $o) = split(/ \s* '=' \s* /, $ol);
$o ~~ s:g/_/ /;
%opt-lang{$l} = $o;
}
push @options, @opt;
push @options-lang, %opt-lang;
my $label = $name.subst('_', ' ', :g);
push @options, [$label, '', $name];
push @options-lang, .value;
}

return %(
Expand All @@ -107,4 +95,13 @@ class Agrammon::Model::Input {
)
}

method !parse-enum-lang-values(Str $value --> Hash) {
my %opt-lang;
for (split("\n", $value)) -> $ol {
my ($l, $o) = split(/ \s* '=' \s* /, $ol);
$o ~~ s:g/_/ /;
%opt-lang{$l} = $o;
}
%opt-lang
}
}
17 changes: 9 additions & 8 deletions lib/Agrammon/OutputFormatter/Text.pm6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,25 @@ use Agrammon::Model;
use Agrammon::Outputs;

sub output-as-text(Agrammon::Model $model, Agrammon::Outputs $outputs, Str $language,
Str $prints, Bool $include-filters --> Str) is export {
Str $prints, Bool $include-filters, Bool :$all-filters = False --> Str) is export {
my @lines;
my @print-set = $prints.split(',');
my @print-set = $prints.split(',') if $prints;
for sorted-kv($outputs.get-outputs-hash) -> $module, $_ {
my $n = 0;
my @module-lines;
my $indent = ' ';
push @module-lines, $module;
when Hash {
for sorted-kv($_) -> $output, $value {
my $val = flat-value($value // 'UNDEFINED');
my $var-print = $model.output-print($module, $output) ~ ',All';
if $var-print.split(',') ∩ @print-set {
if not $prints or $var-print.split(',') ∩ @print-set {
$n++;
my $unit = $model.output-unit($module, $output, $language);
push @module-lines, " $output = $val $unit";
if $include-filters {
if $value ~~ Agrammon::Outputs::FilterGroupCollection && $value.has-filters {
render-filters(@module-lines, $value, $unit, " ");
render-filters(@module-lines, $value, $unit, $indent, :$all-filters);
}
}
}
Expand All @@ -33,13 +34,13 @@ sub output-as-text(Agrammon::Model $model, Agrammon::Outputs $outputs, Str $lang
for sorted-kv(%values) -> $output, $value {
my $val = flat-value($value // 'UNDEFINED');
my $var-print = $model.output-print($module, $output) ~ ',All';
if $var-print.split(',') ∩ @print-set {
if not $prints or $var-print.split(',') ∩ @print-set {
$n++;
my $unit = $model.output-unit($module, $output, $language);
push @module-lines, " $output = $val $unit";
if $include-filters {
if $value ~~ Agrammon::Outputs::FilterGroupCollection && $value.has-filters {
render-filters(@module-lines, $value, $unit, " ");
render-filters(@module-lines, $value, $unit, $indent, :$all-filters);
}
}
}
Expand All @@ -62,8 +63,8 @@ multi sub flat-value(Agrammon::Outputs::FilterGroupCollection $collection) {
}

sub render-filters(@module-lines, Agrammon::Outputs::FilterGroupCollection $collection,
$unit, $prefix) {
my @results = $collection.results-by-filter-group;
$unit, Str $prefix, Bool :$all-filters) {
my @results = $collection.results-by-filter-group(:all($all-filters));
my $longest-filter = @results.map({ .key.map({ .key.chars + .value.chars }) }).flat.max + 1;
for @results {
my %filters := .key;
Expand Down
19 changes: 16 additions & 3 deletions lib/Agrammon/Outputs.pm6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ class X::Agrammon::Outputs::DuplicateInstance is Exception {
}
}

class X::Agrammon::Ouputs::FiltersWithoutFilterSet is Exception {
has Str $.taxonomy-prefix is required;
method message() {
"Cannot create instance with filters without also providing filter set"
}
}

class X::Agrammon::Outputs::IsMultiInstance is Exception {
has $.module is required;
has $.name is required;
Expand Down Expand Up @@ -53,6 +60,7 @@ class Agrammon::Outputs::Instance does Agrammon::Outputs::SingleOutputStorage {
has Str $.taxonomy-prefix is required;
has Str $.instance-name is required;
has %.filters;
has $.filter-set;
has Agrammon::Outputs $.parent is required;

method get-output(Str $module, Str $name) {
Expand Down Expand Up @@ -85,14 +93,18 @@ class Agrammon::Outputs does Agrammon::Outputs::SingleOutputStorage {
%!instances{$taxonomy-prefix} //= {};
}

method new-instance(Str $taxonomy-prefix, Str $instance-name, :%filters --> Agrammon::Outputs::Instance) {
method new-instance(Str $taxonomy-prefix, Str $instance-name, :%filters,
:$filter-set --> Agrammon::Outputs::Instance) {
without %!instances{$taxonomy-prefix} {
die X::Agrammon::Outputs::NotDeclaredMultiInstance.new(module => $taxonomy-prefix);
}
with %!instances{$taxonomy-prefix}{$instance-name} {
die X::Agrammon::Outputs::DuplicateInstance.new(:$taxonomy-prefix, :$instance-name);
}
given Agrammon::Outputs::Instance.new(:$taxonomy-prefix, :$instance-name, :parent(self), :%filters) -> $instance {
if %filters && !$filter-set {
die X::Agrammon::Ouputs::FiltersWithoutFilterSet.new(:$taxonomy-prefix);
}
given Agrammon::Outputs::Instance.new(:$taxonomy-prefix, :$instance-name, :parent(self), :%filters, :$filter-set) -> $instance {
%!instances{$taxonomy-prefix}{$instance-name} = $instance;
return $instance;
}
Expand All @@ -117,7 +129,8 @@ class Agrammon::Outputs does Agrammon::Outputs::SingleOutputStorage {
method get-sum(Str $module, Str $name) {
with self.find-instances($module) {
Agrammon::Outputs::FilterGroupCollection.from-filter-to-value-pairs:
.values.map({ .filters => .get-output($module, $name) })
.values.map({ .filters => .get-output($module, $name) }),
:provenance(set(.values.map(*.filter-set)))
}
else {
# Make sure it's not a bogus use of single-instance symbol,
Expand Down
63 changes: 48 additions & 15 deletions lib/Agrammon/Outputs/FilterGroupCollection.pm6
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ class Agrammon::Outputs::FilterGroupCollection {
}

has Numeric %!values-by-filter{FilterKey};
has Set $.provenance;

submethod BUILD(:@instances!) {
submethod BUILD(:$!provenance = ∅, :@instances!) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cute, finally a useful application of the ∅ ... after having being introduced to it in 5th grade almost 50 years ago :-)

for @instances {
%!values-by-filter{.key} += .value;
}
Expand All @@ -35,8 +36,10 @@ class Agrammon::Outputs::FilterGroupCollection {

#| Create from a list of pairs where the key is a hash of filter values for an instance
#| and the value is the instance's value.
method from-filter-to-value-pairs(@instances) {
self.bless: instances => @instances.map({ FilterKey.new(filters => .key) => +.value })
method from-filter-to-value-pairs(@instances, Set :$provenance = ∅) {
self.bless:
:instances(@instances.map({ FilterKey.new(filters => .key) => +.value })),
:$provenance
}

#| Check if the collection has any filters.
Expand All @@ -54,30 +57,57 @@ class Agrammon::Outputs::FilterGroupCollection {
self.Numeric.Real
}

#| Get a list of pairs mapping filter groups into the total value for that group.
method results-by-filter-group() {
[%!values-by-filter.map({ .key.filters => .value })]
#| Get a list of pairs mapping filter groups into the total value for that
#| group. If :all is passed, then all filters that could possibly have been
#| selected will be included, even if no instance used them, and they will
#| have a zero value.
method results-by-filter-group(Bool :$all = False) {
if $all {
if %!values-by-filter && !$!provenance {
die "Can only get all values when provenance of the filter group was provided";
}
my @results;
for $!provenance.keys.sort(*.module.taxonomy).reverse -> $filter-set {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sort does almost what we need. Will make a separate PR for it,

for $filter-set.all-possible-filter-keys -> %filters {
my $key = FilterKey.new(:%filters);
@results.push(%filters => %!values-by-filter{$key} // 0);
}
}
with %!values-by-filter{FilterKey.empty} {
@results.push({} => $_);
}
@results
}
else {
[%!values-by-filter.map({ .key.filters => .value })]
}
}

#| Produce a new filter group collection which has the values of this one scaled by
#| the specified factor. This can be used to implement `scalar * group`, `group * scalar`
#| (these two just commute), and `group / scalar` (by passing in `1 / scalar` as the
#| factor).
method scale(Numeric $factor --> Agrammon::Outputs::FilterGroupCollection) {
self.bless: instances => %!values-by-filter.map({ .key => $factor * .value })
self.bless:
:instances(%!values-by-filter.map({ .key => $factor * .value })),
:$!provenance
}

#| Produce a new filter group collection which has the values of this one added to
#| a specified additor. This can be used to implement `scalar + group`, `group + scalar`
#| (these two just commute), and `group - scalar` (by passing in `- scalar` as the
#| additor).
method add(Numeric $factor --> Agrammon::Outputs::FilterGroupCollection) {
self.bless: instances => %!values-by-filter.map({ .key => $factor + .value })
self.bless:
:instances(%!values-by-filter.map({ .key => $factor + .value })),
:$!provenance
}

#| Produce a new filter group collection which has the sign of this one.
method sign() {
self.bless: instances => %!values-by-filter.map({ .key => sign( .value ) })
self.bless:
:instances(%!values-by-filter.map({ .key => sign( .value ) })),
:$!provenance
}

#| Apply an operation pairwise between this group collection and another one, returning a
Expand Down Expand Up @@ -109,7 +139,9 @@ class Agrammon::Outputs::FilterGroupCollection {
}
}

Agrammon::Outputs::FilterGroupCollection.new(instances => @result-instances)
Agrammon::Outputs::FilterGroupCollection.new:
instances => @result-instances,
provenance => $!provenance ∪ $other.provenance
}

#| Check in the other filter group collection for values that are greater than a threshold
Expand All @@ -130,17 +162,18 @@ class Agrammon::Outputs::FilterGroupCollection {
else {
# Push 0 if their value > threshold, but key is not existing
# 0 because of missing flow (zero flow)
@result-instances.push: $their-key => 0;
}
}
@result-instances.push: $their-key => 0;
}
}
elsif $push-all {
# Push threshold if their value <= threshold. Could also be 0,
# but it might become handy for limiting ratio to 1, i.e. threshold = 1?
@result-instances.push: $their-key => $thresh;
@result-instances.push: $their-key => $thresh;
}
}

Agrammon::Outputs::FilterGroupCollection.new(instances => @result-instances)
Agrammon::Outputs::FilterGroupCollection.new:
:instances(@result-instances), :$!provenance
}

#| Private accessor to get internal representation of another collection.
Expand Down
Loading