org.matsim.matrices.Matrix Class Reference

Public Member Functions
	Matrix (final String id, final String desc)
final Entry	createAndAddEntry (final String fromLocId, final String toLocId, final double value)
final Entry	setEntry (final String fromLocId, final String toLocId, final double value)
final void	setDesc (final String desc)
final void	removeEntry (final String from_loc, final String to_loc)
final String	getId ()
final String	getDesc ()
final Map< String, ArrayList< Entry > >	getFromLocations ()
final Map< String, ArrayList< Entry > >	getToLocations ()
final List< Entry >	getFromLocEntries (final String fromLocationId)
final List< Entry >	getToLocEntries (final String toLocationId)
final Entry	getEntry (final String from, final String to)
final String	toString ()

Private Attributes
final String	id
String	desc = null
final TreeMap< String, ArrayList< Entry > >	fromLocs = new TreeMap<>()
final TreeMap< String, ArrayList< Entry > >	toLocs = new TreeMap<>()
long	counter = 0
long	nextMsg = 1

Static Private Attributes
static final Logger	log = LogManager.getLogger(Matrix.class)

Detailed Description

Definition at line 31 of file Matrix.java.

Constructor & Destructor Documentation

Matrix()

org.matsim.matrices.Matrix.Matrix	(	final String	id,
		final String	desc
	)

Definition at line 53 of file Matrix.java.

References org.matsim.matrices.Matrix.desc, and org.matsim.matrices.Matrix.id.

                                                      {
        if (id == null) {
            throw new NullPointerException("id must not be null");
        }
        this.id = id;
        this.desc = desc;
    }

Member Function Documentation

createAndAddEntry()

final Entry org.matsim.matrices.Matrix.createAndAddEntry	(	final String	fromLocId,
		final String	toLocId,
		final double	value
	)

Definition at line 65 of file Matrix.java.

Referenced by org.matsim.matrices.Matrix.setEntry(), and org.matsim.matrices.MatricesReaderMatsimV1< T >.startEntry().

                                                                                                           {

        // create an entry
        Entry e = new Entry(fromLocId, toLocId, value);

        // add it to the from location data structure
        if (!this.fromLocs.containsKey(fromLocId)) {
            this.fromLocs.put(fromLocId, new ArrayList<Entry>());
        }
        ArrayList<Entry> fe = this.fromLocs.get(fromLocId);
        fe.add(e);

        // add it to the to location data structure
        if (!this.toLocs.containsKey(toLocId)) {
            this.toLocs.put(toLocId, new ArrayList<Entry>());
        }
        ArrayList<Entry> te = this.toLocs.get(toLocId);
        te.add(e);

        // show counter
        this.counter++;
        if (this.counter % this.nextMsg == 0) {
            this.nextMsg *= 2;
            log.info("Matrix id=" + this.id + ": entry # " + this.counter);
        }

        // return the new entry
        return e;
    }

setEntry()

final Entry org.matsim.matrices.Matrix.setEntry	(	final String	fromLocId,
		final String	toLocId,
		final double	value
	)

Definition at line 99 of file Matrix.java.

References org.matsim.matrices.Matrix.createAndAddEntry(), org.matsim.matrices.Matrix.getEntry(), and org.matsim.matrices.Entry.setValue().

                                                                                                  {
        Entry e = getEntry(fromLocId, toLocId);
        if (e == null) {
            return createAndAddEntry(fromLocId, toLocId, value);
        }
        e.setValue(value);
        return e;
    }

Here is the call graph for this function:

setDesc()

final void org.matsim.matrices.Matrix.setDesc

(

final String

desc

)

Definition at line 108 of file Matrix.java.

References org.matsim.matrices.Matrix.desc.

Referenced by org.matsim.visum.VisumMatrixReader.readFile().

                                                 {
        this.desc = desc;
    }

removeEntry()

final void org.matsim.matrices.Matrix.removeEntry	(	final String	from_loc,
		final String	to_loc
	)

Definition at line 116 of file Matrix.java.

References org.matsim.matrices.Matrix.getEntry().

                                                                              {
        Entry entry = getEntry(from_loc, to_loc);
        ArrayList<Entry> from_loc_entries = this.fromLocs.get(from_loc);
        ArrayList<Entry> to_loc_entries = this.toLocs.get(to_loc);

        if ((from_loc_entries == null) || (to_loc_entries == null)) {
            throw new RuntimeException("entry with from_loc_id=" + from_loc +
                         " and to_loc_id=" + to_loc + " does not exist!" +
                         " Inconsistent data strucutre!!!");
        }

        if (!from_loc_entries.remove(entry)) {
            throw new RuntimeException("entry with from_loc_id=" + from_loc +
                     " and to_loc_id=" + to_loc + " does not exist!" +
                     " Inconsistent data strucutre!!!");
        }
        if (from_loc_entries.isEmpty()) {
            this.fromLocs.remove(from_loc);
        }

        if (!to_loc_entries.remove(entry)) {
            throw new RuntimeException("entry with from_loc_id=" + from_loc +
                     " and to_loc_id=" + to_loc + " does not exist!" +
                     " Inconsistent data strucutre!!!");
        }
        if (to_loc_entries.isEmpty()) {
            this.toLocs.remove(to_loc);
        }
        log.info("entry " + entry.toString() + " removed.");
    }

Here is the call graph for this function:

getId()

final String org.matsim.matrices.Matrix.getId

(

)

Definition at line 151 of file Matrix.java.

References org.matsim.matrices.Matrix.id.

                                {
        return this.id;
    }

getDesc()

final String org.matsim.matrices.Matrix.getDesc

(

)

Definition at line 155 of file Matrix.java.

References org.matsim.matrices.Matrix.desc.

                                  {
        return this.desc;
    }

getFromLocations()

final Map<String, ArrayList<Entry> > org.matsim.matrices.Matrix.getFromLocations

(

)

Definition at line 159 of file Matrix.java.

References org.matsim.matrices.Matrix.fromLocs.

Referenced by org.matsim.visum.VisumMatrixWriter.VisumMatrixWriter(), and org.matsim.matrices.MatricesWriter.write().

                                                                  {
        return this.fromLocs;
    }

getToLocations()

final Map<String, ArrayList<Entry> > org.matsim.matrices.Matrix.getToLocations

(

)

Definition at line 163 of file Matrix.java.

References org.matsim.matrices.Matrix.toLocs.

Referenced by org.matsim.visum.VisumMatrixWriter.VisumMatrixWriter().

                                                                {
        return this.toLocs;
    }

getFromLocEntries()

final List<Entry> org.matsim.matrices.Matrix.getFromLocEntries

(

final String

fromLocationId

)

Definition at line 167 of file Matrix.java.

                                                                            {
        return this.fromLocs.get(fromLocationId);
    }

getToLocEntries()

final List<Entry> org.matsim.matrices.Matrix.getToLocEntries

(

final String

toLocationId

)

Definition at line 171 of file Matrix.java.

                                                                        {
        return this.toLocs.get(toLocationId);
    }

getEntry()

final Entry org.matsim.matrices.Matrix.getEntry	(	final String	from,
		final String	to
	)

Definition at line 175 of file Matrix.java.

References org.matsim.matrices.Entry.getToLocation().

Referenced by org.matsim.matrices.Matrix.removeEntry(), org.matsim.matrices.Matrix.setEntry(), and org.matsim.visum.VisumMatrixWriter.writeFile().

                                                                    {
        ArrayList<Entry> fe = this.fromLocs.get(from);
        if (fe == null) return null;
        for (int i=0; i<fe.size(); i++) {
            Entry e = fe.get(i);
            if (e.getToLocation().equals(to)) {
                return e;
            }
        }
        return null;
    }

Here is the call graph for this function:

toString()

final String org.matsim.matrices.Matrix.toString

(

)

Definition at line 192 of file Matrix.java.

                                   {
        return "[id=" + this.id + "]" +
                "[desc=" + this.desc + "]" +
                "[nof_from_locs=" + this.fromLocs.size() + "]" +
                "[nof_to_locs=" + this.toLocs.size() + "]";
    }

Member Data Documentation

id

final String org.matsim.matrices.Matrix.id

private

Definition at line 37 of file Matrix.java.

Referenced by org.matsim.matrices.Matrix.getId(), and org.matsim.matrices.Matrix.Matrix().

desc

String org.matsim.matrices.Matrix.desc = null

private

Definition at line 38 of file Matrix.java.

Referenced by org.matsim.matrices.Matrix.getDesc(), org.matsim.matrices.Matrix.Matrix(), and org.matsim.matrices.Matrix.setDesc().

fromLocs

final TreeMap<String,ArrayList<Entry> > org.matsim.matrices.Matrix.fromLocs = new TreeMap<>()

private

Definition at line 41 of file Matrix.java.

Referenced by org.matsim.matrices.Matrix.getFromLocations().

toLocs

final TreeMap<String,ArrayList<Entry> > org.matsim.matrices.Matrix.toLocs = new TreeMap<>()

private

Definition at line 42 of file Matrix.java.

Referenced by org.matsim.matrices.Matrix.getToLocations().

log

final Logger org.matsim.matrices.Matrix.log = LogManager.getLogger(Matrix.class)

staticprivate

Definition at line 44 of file Matrix.java.

counter

long org.matsim.matrices.Matrix.counter = 0

private

Definition at line 46 of file Matrix.java.

nextMsg

long org.matsim.matrices.Matrix.nextMsg = 1

private

Definition at line 47 of file Matrix.java.

---

The documentation for this class was generated from the following file:

• matrices/Matrix.java