src.libs/CjLS_geopow.hh

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
/*
 * mitie
 * Copyright (C) Jason Spencer 2009 <mitie@jasonspencer.org>
 * 
 * mitie is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * mitie is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _CJLS_GEOPOW_H_
#define _CJLS_GEOPOW_H_ 1

#include <string>
#include "CjLinkSelector.hh"

namespace jmitie {
        namespace corelib {
class CjLS_geopow : public CjLinkSelector {
public:

static std::string getName_static() { return "geopow"; }
virtual std::string getName() const { return getName_static(); }
std::string getProperty(const std::string & prop) const { return getProperty_static(prop); }
static std::string getProperty_static(const std::string & opt) {
        if(opt=="desc") return "Selects a link or node-pair preferring those with a higher value of alpha*geographic_distance_between_nodes_in_pair^beta.";
        if(opt=="usage") return getProperty_static("desc") + "\n" +
                        "alpha=float\tSpecifies the value to use for the distance co-efficient.\n" \
                        "beta=float\tSpecifies the value to use for the distance exponent.\n" \
                        "[no_warn]\tDisables the warning about values of alpha and beta outside of expected bounds.\n"\
                        "[dupe_ok]\tIf specified a node pairs which are already connected are included in the node-pair selection(only applies when adding links).\n";
        throw std::invalid_argument("CjLS_geopow::getProperty_static(" + opt + "): Unknown property requested.");
}

CjLS_geopow(std::string args, const ctor_va_t & va );

virtual bool selectLink( select_arg_t &, unsigned int & from, unsigned int & to  );
virtual ~CjLS_geopow() {};

protected:
bool m_add_remove;
double m_alpha;
double m_beta;
bool m_dupe_link_ok;
bool m_no_alpha_beta_warn;

private:

};
} // namespace corelib
} // namespace jmitie

#endif // _CJLS_GEOPOW_H_