Representation function#
Descriptions of the basic functions are given below.
Function descriptions:
- representations.maxoidRepresentation(candidates, clusterOrder)[source]#
Represents the candidates of a given cluster group (clusterOrder) by its medoid, measured with the euclidean distance.
- Parameters:
candidates (np.ndarray) – Dissimilarity matrix where each row represents a candidate. required
clusterOrder (np.array) – Integer array where the index refers to the candidate and the Integer entry to the group. required
- representations.medoidRepresentation(candidates, clusterOrder)[source]#
Represents the candidates of a given cluster group (clusterOrder) by its medoid, measured with the euclidean distance.
- Parameters:
candidates (np.ndarray) – Dissimilarity matrix where each row represents a candidate. required
clusterOrder (np.array) – Integer array where the index refers to the candidate and the Integer entry to the group. required
- representations.meanRepresentation(candidates, clusterOrder)[source]#
Represents the candidates of a given cluster group (clusterOrder) by its mean.
- Parameters:
candidates (np.ndarray) – Dissimilarity matrix where each row represents a candidate. required
clusterOrder (np.array) – Integer array where the index refers to the candidate and the Integer entry to the group. required
- representations.minmaxmeanRepresentation(candidates, clusterOrder, representationDict, timeStepsPerPeriod)[source]#
Represents the candidates of a given cluster group (clusterOrder) by either the minimum, the maximum or the mean values of each time step for all periods in that cluster depending on the command for each attribute.
- Parameters:
candidates (np.ndarray) – Dissimilarity matrix where each row represents a candidate. required
clusterOrder (np.array) – Integer array where the index refers to the candidate and the Integer entry to the group. required
representationDict (dictionary) – A dictionary which defines for each attribute whether the typical period should be represented by the minimum or maximum values within each cluster. optional (default: None)
timeStepsPerPeriod (integer) – The number of discrete timesteps which describe one period. required