package transformers import ( "container/list" "errors" "fmt" "os" "strings" "github.com/johnkerl/miller/v6/pkg/bifs" "github.com/johnkerl/miller/v6/pkg/cli" "github.com/johnkerl/miller/v6/pkg/lib" "github.com/johnkerl/miller/v6/pkg/mlrval" "github.com/johnkerl/miller/v6/pkg/types" ) // ---------------------------------------------------------------- const verbNameFraction = "fraction" var FractionSetup = TransformerSetup{ Verb: verbNameFraction, UsageFunc: transformerFractionUsage, ParseCLIFunc: transformerFractionParseCLI, IgnoresInput: false, } func transformerFractionUsage( o *os.File, ) { argv0 := "mlr" verb := verbNameFraction fmt.Fprintf(o, "Usage: %s %s [options]\n", argv0, verb) fmt.Fprintf(o, "For each record's value in specified fields, computes the ratio of that\n") fmt.Fprintf(o, "value to the sum of values in that field over all input records.\n") fmt.Fprintf(o, "E.g. with input records x=1 x=2 x=3 and x=4, emits output records\n") fmt.Fprintf(o, "x=1,x_fraction=0.1 x=2,x_fraction=0.2 x=3,x_fraction=0.3 and x=4,x_fraction=0.4\n") fmt.Fprintf(o, "\n") fmt.Fprintf(o, "Note: this is internally a two-pass algorithm: on the first pass it retains\n") fmt.Fprintf(o, "input records and accumulates sums; on the second pass it computes quotients\n") fmt.Fprintf(o, "and emits output records. This means it produces no output until all input is read.\n") fmt.Fprintf(o, "\n") fmt.Fprintf(o, "Options:\n") fmt.Fprintf(o, "-f {a,b,c} Field name(s) for fraction calculation\n") fmt.Fprintf(o, "-g {d,e,f} Optional group-by-field name(s) for fraction counts\n") fmt.Fprintf(o, "-p Produce percents [0..100], not fractions [0..1]. Output field names\n") fmt.Fprintf(o, " end with \"_percent\" rather than \"_fraction\"\n") fmt.Fprintf(o, "-c Produce cumulative distributions, i.e. running sums: each output\n") fmt.Fprintf(o, " value folds in the sum of the previous for the specified group\n") fmt.Fprintf(o, " E.g. with input records x=1 x=2 x=3 and x=4, emits output records\n") fmt.Fprintf(o, " x=1,x_cumulative_fraction=0.1 x=2,x_cumulative_fraction=0.3\n") fmt.Fprintf(o, " x=3,x_cumulative_fraction=0.6 and x=4,x_cumulative_fraction=1.0\n") } func transformerFractionParseCLI( pargi *int, argc int, args []string, _ *cli.TOptions, doConstruct bool, // false for first pass of CLI-parse, true for second pass ) IRecordTransformer { // Skip the verb name from the current spot in the mlr command line argi := *pargi verb := args[argi] argi++ // Parse local flags var fractionFieldNames []string = nil var groupByFieldNames []string = nil doPercents := false doCumu := false for argi < argc /* variable increment: 1 or 2 depending on flag */ { opt := args[argi] if !strings.HasPrefix(opt, "-") { break // No more flag options to process } if args[argi] == "--" { break // All transformers must do this so main-flags can follow verb-flags } argi++ if opt == "-h" || opt == "--help" { transformerFractionUsage(os.Stdout) os.Exit(0) } else if opt == "-f" { fractionFieldNames = cli.VerbGetStringArrayArgOrDie(verb, opt, args, &argi, argc) } else if opt == "-g" { groupByFieldNames = cli.VerbGetStringArrayArgOrDie(verb, opt, args, &argi, argc) } else if opt == "-p" { doPercents = true } else if opt == "-c" { doCumu = true } else { transformerFractionUsage(os.Stderr) os.Exit(1) } } if fractionFieldNames == nil { transformerFractionUsage(os.Stderr) os.Exit(1) } *pargi = argi if !doConstruct { // All transformers must do this for main command-line parsing return nil } transformer, err := NewTransformerFraction( fractionFieldNames, groupByFieldNames, doPercents, doCumu, ) if err != nil { fmt.Fprintln(os.Stderr, err) os.Exit(1) } return transformer } // ---------------------------------------------------------------- type TransformerFraction struct { fractionFieldNames []string groupByFieldNames []string doCumu bool recordsAndContexts *list.List // Two-level map: Group-by field names are the first keyset; // fraction field names are keys into the second. sums map[string]map[string]*mlrval.Mlrval cumus map[string]map[string]*mlrval.Mlrval outputFieldNameSuffix string // "_fraction" or "_percent" multiplier *mlrval.Mlrval // 1.0 for fraction or 100.0 for percent zero *mlrval.Mlrval } // ---------------------------------------------------------------- func NewTransformerFraction( fractionFieldNames []string, groupByFieldNames []string, doPercents bool, doCumu bool, ) (*TransformerFraction, error) { recordsAndContexts := list.New() sums := make(map[string]map[string]*mlrval.Mlrval) cumus := make(map[string]map[string]*mlrval.Mlrval) var multiplier *mlrval.Mlrval var outputFieldNameSuffix string if doPercents { multiplier = mlrval.FromInt(100) if doCumu { outputFieldNameSuffix = "_cumulative_percent" } else { outputFieldNameSuffix = "_percent" } } else { multiplier = mlrval.FromInt(1) if doCumu { outputFieldNameSuffix = "_cumulative_fraction" } else { outputFieldNameSuffix = "_fraction" } } zero := mlrval.FromInt(0) return &TransformerFraction{ fractionFieldNames: fractionFieldNames, groupByFieldNames: groupByFieldNames, doCumu: doCumu, recordsAndContexts: recordsAndContexts, sums: sums, cumus: cumus, outputFieldNameSuffix: outputFieldNameSuffix, multiplier: multiplier, zero: zero, }, nil } // ---------------------------------------------------------------- func (tr *TransformerFraction) Transform( inrecAndContext *types.RecordAndContext, outputRecordsAndContexts *list.List, // list of *types.RecordAndContext inputDownstreamDoneChannel <-chan bool, outputDownstreamDoneChannel chan<- bool, ) { HandleDefaultDownstreamDone(inputDownstreamDoneChannel, outputDownstreamDoneChannel) if !inrecAndContext.EndOfStream { // Not end of stream; pass 1 inrec := inrecAndContext.Record // Append records into a single output list (so that this verb is order-preserving). tr.recordsAndContexts.PushBack(inrecAndContext) // Accumulate sums of fraction-field values grouped by group-by field names groupingKey, hasAll := inrec.GetSelectedValuesJoined(tr.groupByFieldNames) if hasAll { sumsForGroup := tr.sums[groupingKey] var cumusForGroup map[string]*mlrval.Mlrval = nil if sumsForGroup == nil { sumsForGroup = make(map[string]*mlrval.Mlrval) tr.sums[groupingKey] = sumsForGroup cumusForGroup = make(map[string]*mlrval.Mlrval) tr.cumus[groupingKey] = cumusForGroup } for _, fractionFieldName := range tr.fractionFieldNames { value := inrec.Get(fractionFieldName) if value != nil { value.AssertNumeric() // may fatal the process sum := sumsForGroup[fractionFieldName] if sum == nil { // First value for group sumsForGroup[fractionFieldName] = value.Copy() cumusForGroup[fractionFieldName] = tr.zero } else { sumsForGroup[fractionFieldName] = bifs.BIF_plus_binary(sum, value) } } } } } else { // End of stream; pass 2 // Iterate over the retained records, decorating them with fraction fields. endOfStreamContext := inrecAndContext.Context for { element := tr.recordsAndContexts.Front() if element == nil { break } tr.recordsAndContexts.Remove(element) recordAndContext := element.Value.(*types.RecordAndContext) outrec := recordAndContext.Record groupingKey, hasAll := outrec.GetSelectedValuesJoined(tr.groupByFieldNames) if hasAll { sumsForGroup := tr.sums[groupingKey] cumusForGroup := tr.cumus[groupingKey] lib.InternalCodingErrorIf(sumsForGroup == nil) // should have been populated on pass 1 for _, fractionFieldName := range tr.fractionFieldNames { value := outrec.Get(fractionFieldName) if value != nil { value.AssertNumeric() // may fatal the process var numerator *mlrval.Mlrval = nil var cumu *mlrval.Mlrval = nil var outputValue *mlrval.Mlrval = nil if tr.doCumu { cumu = cumusForGroup[fractionFieldName] numerator = bifs.BIF_plus_binary(value, cumu) } else { numerator = value } denominator := sumsForGroup[fractionFieldName] // Return 0 for 0/n if mlrval.Equals(numerator, tr.zero) { outputValue = tr.zero } else if !mlrval.Equals(denominator, tr.zero) { outputValue = bifs.BIF_divide(numerator, denominator) outputValue = bifs.BIF_times(outputValue, tr.multiplier) } else { outputValue = mlrval.FromError( errors.New( "mlr fraction: division by zero", ), ) } outrec.PutCopy( fractionFieldName+tr.outputFieldNameSuffix, outputValue, ) if tr.doCumu { cumusForGroup[fractionFieldName] = bifs.BIF_plus_binary(cumu, value) } } } } outputRecordsAndContexts.PushBack(types.NewRecordAndContext(outrec, &endOfStreamContext)) } outputRecordsAndContexts.PushBack(inrecAndContext) // end-of-stream marker } }