Document SubsetGenerator and EnsembleBuilder

[Markus Ringnér]

Both SubsetGenerator and EnsembleBuilder use a template argument Data (called T for SubsetGenerator). There are some requirements for this type which KernelLookup, MatrixLookup, and MatrixLookupWeighted fulfill. These requirements should be specified and documented as a concept.

[Peter]

Well, the requirement is that the type is MatrixLookup?, MatrixLookupWeighted? or KernelLookup?. Both SubsetGenerator? and EnsembleBuilder? have some specialized code depending on which data type that are used (see e.g. functions test_data in EnsembleBuilder).

This means two things. 1) you cannot come with your own Data class and make it work with these classes. 2) There is not much of an overlap of requirements, so I'm not sure what we should document here. Seems overkill to create a Concept page saying Concept Data is implemented in MatrixLookup?, MatrixLookupWeighted?, and KernelLookup?.

[Markus Ringnér]

OK I see, so this ticket should be changed (and split) into 'Document SubsetGenerator and EnsembleBuilder'. Both of these classes are poorly documented and at least it should be made clear that Data can be one of the three Lookups only. I guess EnsembleBuilder will be worked on a lot in a later yat version than 0.4, so it may be premature to do much documentation of it. But SubsetGenerator is relatively fixed after the major revisions on this part of the structure for 0.4 isn't it?

[Peter]

(In [1220]) docs for SubsetGenerator?.

[Peter]

(In [1227]) docs for EnsembleBuilder?