Outranking-PrefRank_scores

Version:1.0.0
Provider:PUT
SOAP service’s name:
 Outranking-PrefRank_scores-PUT (see SOAP requests for details)

Description

Module for calculation outranking PrefRank scores.

Contact: Krzysztof Martyn <krzysztof.martyn@wp.pl>

Web page: https://bitbucket.org/Krzysztof_Martyn/prefrank

Inputs

(For outputs, see below)

alternatives

Alternatives to consider.

The input value should be a valid XMCDA document whose main tag is <alternatives>.


preferences

Aggregated preferences matrix.

The input value should be a valid XMCDA document whose main tag is <alternativesMatrix>.


parameters

Parameter specifies the algorithm to calculate ranking. There are three algorithms to choose from: PageRank, HITS and Salsa.

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

<programParameters>
        <parameter id="algorithm_type" name="algorithm_type">
                <values>
                        <value>
                                <label>%1</label>
                        </value>
                </values>
        </parameter>
        <parameter id="number_of_iteration" name="number_of_iteration">
                <values>
                        <value>
                                <integer>%2</integer>
                        </value>
                </values>
        </parameter>
        <parameter id="check_convergence" name="check_convergence">
                <values>
                        <value>
                                <boolean>%3</boolean>
                        </value>
                </values>
        </parameter>
        <parameter id="early_stopping" name="early_stopping">
                <values>
                        <value>
                                <boolean>%4</boolean>
                        </value>
                </values>
        </parameter>
</programParameters>

where:

  • %1 is a parameter named “algorithm type”. It can have the following values:

    • prefrank_1: PrefRank I
    • prefrank_2: PrefRank II
    • prefrank_3: PrefRank III

    The default value is item0.

  • %2 is a parameter named “number of iteration”. This is a int, and the value should conform to the following constraint: The value should be greater than 1. More formally, the constraint is:

    %3 > 1
    

    The default value is 100.

  • %3 is a parameter named “Run averaging if not converge?”. This is a boolean. The default value is false.

  • %4 is a parameter named “Earlier stop if converge?”. This is a boolean. The default value is true.


Outputs

positive_flows

Positive outranking flows.

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


negative_flows

Negative outranking flows.

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


total_flows

Final flows computed from the given data.

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


ranking

PrefRank scores computed from the given data.

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


messages

Messages or errors generated by this module.

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


Original xml description