src.libs/CjLS_degree.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_DEGREE_H_
#define _CJLS_DEGREE_H_ 1

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

namespace jmitie {
        namespace corelib {

class CjLS_degree : public CjLinkSelector {
public:

static std::string getName_static() { return "degree"; }
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 based on the degree of the nodes.";
        if(opt=="usage") return getProperty_static("desc") + "\n" +
                        "(diff|add)\tSpecify whether the difference or sum of the degrees should be put into the wheel for selection.\n" \
                        "[exp=float]\tThe sum or difference is taken to this power before it is placed in the selection wheel.\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_degree::getProperty_static(" + opt + "): Unknown property requested.");
}

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

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

protected:
bool m_add_remove;
bool m_diff_add;        // if 0 then diff the degrees
bool m_exp_set;
double m_deg_exp;
bool m_dupe_link_ok;

private:

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

#endif // _CJLS_DEGREE_H_