HierarchicalDEA-ValueAdditive-SMAA_ranks

SOAP service’s name:
Version:	1.0
Provider:	PUT
	`HierarchicalDEA-ValueAdditive-SMAA_ranks-PUT` (see SOAP requests for details)

Description

Computes ranks for the given DMUs (alternatives) using SMAA-D method and Additive Data Envelopment Analysis Model: with hierarchical structure of inputs and outputs. For given number of samples returns a matrix with alternatives in each row and rankings in each column. Single cell indicates how many samples of respective alternative gave respective position in ranking.
Contact:: Anna Labijak <anna.labijak@cs.put.poznan.pl>

Inputs

(For outputs, see below)

units
inputsOutputsScales
performanceTable
hierarchy
weightsLinearConstraints (optional)
methodParameters

units

A list of alternatives (DMUs).

The input value should be a valid XMCDA document whose main tag is <alternatives>. It must have the following form:

<alternatives>
        <alternative>
            [...]
        </alternative>
        [...]
    </alternatives>

inputsOutputsScales

Information about inputs and outpus (leaf criteria) scales (preference directions) and optionally about boundaries

The input value should be a valid XMCDA document whose main tag is <criteriaScales>. It must have the following form:

<criteriaScales>

<criterionScale>

<criterionID>[…]</criterionID> <scales>

<scale>

[…]

</scale>

</scales>

</criterionScale> […]

</criteriaScales>

performanceTable

A list of alternatives (DMUs) performances (on leaf hierarchy criteria).

The input value should be a valid XMCDA document whose main tag is <performanceTable>. It must have the following form:

<performanceTable>
                                <alternativePerformances>
                                        <alternativeID> [...] </alternativeID>
                                        <performance>
                                                <criterionID>
                                                        [...]
                                                </criterionID>
                                                <values><value>[...]</value></values>
                                        </performance>
                                        [...]
                                </alternativePerformances>
                                [...]
                        </performanceTable>

hierarchy

The hierarchical structure of criteria.

The input value should be a valid XMCDA document whose main tag is <criteriaHierarchy>. It must have the following form:

<criteriaHierarchy>
                                <nodes>
            <node>
                <criterionID>[...]</criterionID>
                <nodes>
                    <node>
                        <criterionID>[...]</criterionID>
                        [...]
                    </node>
                    [...]
                </nodes>
            </node>
        <nodes>
                        </criteriaHierarchy>

weightsLinearConstraints (optional)

A list of hierarchy criteria linear constraints.

The input value should be a valid XMCDA document whose main tag is <criteriaLinearConstraints>. It must have the following form:

<criteriaLinearConstraints>
    <constraints>
        <constraint>
            <elements>
                <element>
                    <criterionID> [...] </criterionID>
                    <coefficient>
                        [...]
                    </coefficient>
                </element>
                [...]
            </elements>
            <operator>[...]</operator>
            <rhs>
                [...]
            </rhs>
        </constraint>
        [...]
    </constraints>
</criteriaLinearConstraints>

methodParameters

Represents parameters.: “number of samples” represents the number of samples to generate; “hierarchy node” is the ID of the hierarchy criterion for which the analysis should be performed; “transformToUtilities” means if data should be tranformed into values from range [0-1]; “boundariesProvided” means if inputsOutputs file contains information about min and max data for each factor.

The input value should be a valid XMCDA document whose main tag is <programParameters>. It must have the following form:

<programParameters>
    <parameter id="samplesNb">
        <values>
            <value><integer>%1</integer></value>
        </values>
    </parameter>
    <parameter id="hierarchyNode">
        <values>
            <value><label>%2</label></value>
        </values>
    </parameter>
    <parameter id="transformToUtilities">
  <values>
    <value><boolean>%3</boolean></value>
  </values>
            </parameter>
            <parameter id="boundariesProvided">
  <values>
    <value><boolean>%4</boolean></value>
  </values>
            </parameter>
    <parameter id="randomSeed">
        <values>
            <value><integer>%5</integer></value>
        </values>
    </parameter>
</programParameters>

where:

%1 is a parameter named “number of samples”. This is a int, and the value should conform to the following constraint: The value should be a positive integer.. More formally, the constraint is:
```
%1 > 0
```
The default value is 100.
%2 is a parameter named “hierarchy node”. This is a string. The default value is root.
%3 is a parameter named “transform to utilities”. This is a boolean. The default value is true.
%4 is a parameter named “boundaries provided”. This is a boolean. The default value is false.
%5 is a parameter named “random seed (-1 for default time-based seed)”. This is a int, and the value should conform to the following constraint: The value should be a non-negative integer or -1 if no constant seed required.. More formally, the constraint is:
```
%5 >= -1
```
The default value is -1.

rankAcceptabilityIndices

A performance table for given alternatives. Single performance consists of attribute criterionID representing certain ranking, and a value representing ratio of samples attaining this ranking.

The returned value is a XMCDA document whose main tag is <performanceTable>. It has the following form:

    <performanceTable>
                                    <alternativePerformances>
                                            <alternativeID> [...] </alternativeID>
                                            <performance>
                                                    <criterionID> Rank [...]</criterionID>
                                                            <values>
                                                              <value>[...]</value>
                                                            </values>
                                            </performance>
                                            [...]
                                    </alternativePerformances>
[...]
                            </performanceTable>

avgRank

A list of alternatives with average rank (obtained for given sample).

The returned value is a XMCDA document whose main tag is <alternativesValues>. It has the following form:

<alternativesValues>
                                <alternativeValue>
                                  <alternativeID> [...] </alternativeID>
                                  <values>
                                          <value>[...]</value>
                                  </values>
                                </alternativeValue>
                                [...]
                        </alternativesValues>

messages

A list of messages generated by the algorithm.

The returned value is a XMCDA document whose main tag is <programExecutionResult>.

Original xml description

description.xml