summaryrefslogtreecommitdiff
path: root/geom_matching/wasserstein/include/auction_runner_gs.h
blob: ce139f140080e685688d99eea25887fe2a1825c7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*

Copyright (c) 2016, M. Kerber, D. Morozov, A. Nigmetov
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


You are under no obligation whatsoever to provide any bug fixes, patches, or
upgrades to the features, functionality or performance of the source code
(Enhancements) to anyone; however, if you choose to make your Enhancements
available either publicly, or directly to copyright holder,
without imposing a separate written license agreement for such Enhancements,
then you hereby grant the following license: a  non-exclusive, royalty-free
perpetual license to install, use, modify, prepare derivative works, incorporate
into other computer software, distribute, and sublicense such enhancements or
derivative works thereof, in binary and source code form.

  */

#ifndef AUCTION_RUNNER_GS_H
#define AUCTION_RUNNER_GS_H

#include <unordered_set>

#include "auction_oracle.h"

//#define KEEP_UNASSIGNED_ORDERED
// if this symbol is defined,
// unassigned bidders are processed in a lexicographic order.
// See LexicogrCompDiagramPoint comparator.


namespace geom_ws {

//using AuctionOracle = AuctionOracleLazyHeapRestricted;
using AuctionOracle = AuctionOracleKDTreeRestricted;

#ifdef KEEP_UNASSIGNED_ORDERED
using IdxPointPair = std::pair<size_t, DiagramPoint>;

struct LexicogrCompDiagramPoint {
    bool operator ()(const IdxPointPair& a, const IdxPointPair& b) {
        const auto& p1 = a.second;
        const auto& p2 = b.second;

        return ( (not p1.isDiagonal() and p2.isDiagonal()) or
                ( p1.isDiagonal() == p2.isDiagonal() and p1.getRealX() < p2.getRealX() ) or
                ( p1.isDiagonal() == p2.isDiagonal() and p1.getRealX() == p2.getRealX() and p1.getRealY() < p2.getRealY() ) or
                ( p1.isDiagonal() == p2.isDiagonal() and p1.getRealX() == p2.getRealX() and p1.getRealY() == p2.getRealY() and a.first < b.first ) );
    }
};

using OrderedUnassignedKeeper = std::set<IdxPointPair, LexicogrCompDiagramPoint>;
#endif

// the two parameters that you can tweak in auction algorithm are:
// 1. epsilonCommonRatio
// 2. maxIterNum

class AuctionRunnerGS {
public:
    AuctionRunnerGS(const std::vector<DiagramPoint>& A,
                    const std::vector<DiagramPoint>& B,
                    const double q,
                    const double _delta,
                    const double _internal_p,
                    const double _initialEpsilon,
                    const double _epsFactor);
    void setEpsilon(double newVal) { assert(epsilon > 0.0); epsilon = newVal; };
    double getEpsilon() const { return epsilon; }
    double getWassersteinDistance();
    double getWassersteinCost();
    double getRelativeError() const { return relativeError; };
    static constexpr int maxIterNum { 35 }; // maximal number of iterations of epsilon-scaling
private:
    // private data
    std::vector<DiagramPoint> bidders, items;
    const size_t numBidders;
    const size_t numItems;
    std::vector<IdxType> itemsToBidders;
    std::vector<IdxType> biddersToItems;
    double wassersteinPower;
    double epsilon;
    double delta;
    double internal_p;
    double initialEpsilon;
    double epsilonCommonRatio; // next epsilon = current epsilon / epsilonCommonRatio
    double weightAdjConst;
    double wassersteinDistance;
    double wassersteinCost;
    double relativeError;
    // to get the 2 best items
    std::unique_ptr<AuctionOracle> oracle;
#ifdef KEEP_UNASSIGNED_ORDERED
    OrderedUnassignedKeeper unassignedBidders;
#else
    std::unordered_set<size_t> unassignedBidders;
#endif
    // private methods
    void assignItemToBidder(const IdxType bidderIdx, const IdxType itemsIdx);
    void clearBidTable(void);
    void runAuction(void);
    void runAuctionPhase(void);
    void flushAssignment(void);

    // for debug only
    void sanityCheck(void);
    void printDebug(void);
    int countUnhappy(void);
    void printMatching(void);
    double getDistanceToQthPowerInternal(void);
    int numRounds { 0 };
};

} // end of namespace geom_ws

#endif