+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview 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.
+ *
+ * Jalview 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 Jalview. If not, see <http://www.gnu.org/licenses/>.
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.datamodel.features;
import jalview.datamodel.SequenceFeature;
import java.util.ArrayList;
+import java.util.Collection;
import java.util.Collections;
-import java.util.Comparator;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
-/**
- * A data store for a set of sequence features that supports efficient lookup of
- * features overlapping a given range. Intended for (but not limited to) storage
- * of features for one sequence and feature type.
- *
- * @author gmcarstairs
- *
- */
+import intervalstore.api.IntervalStoreI;
+import intervalstore.impl.BinarySearcher;
+import intervalstore.impl.BinarySearcher.Compare;
+
public class FeatureStore
{
- /**
- * a class providing criteria for performing a binary search of a list
- */
- abstract static class SearchCriterion
+ public enum IntervalStoreType
{
/**
- * Answers true if the entry passes the search criterion test
- *
- * @param entry
- * @return
+ * original NCList-based IntervalStore
*/
- abstract boolean compare(SequenceFeature entry);
-
- static SearchCriterion byStart(final long target)
- {
- return new SearchCriterion() {
-
- @Override
- boolean compare(SequenceFeature entry)
- {
- return entry.getBegin() >= target;
- }
- };
- }
-
- static SearchCriterion byEnd(final long target)
- {
- return new SearchCriterion()
- {
-
- @Override
- boolean compare(SequenceFeature entry)
- {
- return entry.getEnd() >= target;
- }
- };
- }
+ INTERVAL_STORE_NCLIST,
- static SearchCriterion byFeature(final ContiguousI to,
- final Comparator<ContiguousI> rc)
- {
- return new SearchCriterion()
- {
+ /**
+ * linked-list IntervalStore
+ */
+ INTERVAL_STORE_LINKED_LIST,
- @Override
- boolean compare(SequenceFeature entry)
- {
- return rc.compare(entry, to) >= 0;
- }
- };
- }
+ /**
+ * NCList as array buffer IntervalStore
+ */
+ INTERVAL_STORE_NCARRAY
}
- Comparator<ContiguousI> startOrdering = new RangeComparator(true);
+ /*
+ * track largest start for quick insertion of ordered features
+ */
+ protected int maxStart = -1;
- Comparator<ContiguousI> endOrdering = new RangeComparator(false);
+ protected int maxContactStart = -1;
/*
* Non-positional features have no (zero) start/end position.
List<SequenceFeature> nonPositionalFeatures;
/*
- * An ordered list of features, with the promise that no feature in the list
- * properly contains any other. This constraint allows bounded linear search
- * of the list for features overlapping a region.
- * Contact features are not included in this list.
- */
- List<SequenceFeature> nonNestedFeatures;
-
- /*
* contact features ordered by first contact position
*/
List<SequenceFeature> contactFeatureStarts;
List<SequenceFeature> contactFeatureEnds;
/*
- * Nested Containment List is used to hold any features that are nested
- * within (properly contained by) any other feature. This is a recursive tree
- * which supports depth-first scan for features overlapping a range.
- * It is used here as a 'catch-all' fallback for features that cannot be put
- * into a simple ordered list without invalidating the search methods.
+ * IntervalStore holds remaining features and provides efficient
+ * query for features overlapping any given interval
*/
- NCList<SequenceFeature> nestedFeatures;
+ IntervalStoreI<SequenceFeature> features;
/*
* Feature groups represented in stored positional features
float nonPositionalMaxScore;
/**
- * Constructor
+ * Answers the 'length' of the feature, counting 0 for non-positional features
+ * and 1 for contact features
+ *
+ * @param feature
+ * @return
*/
- public FeatureStore()
+ protected static int getFeatureLength(SequenceFeature feature)
{
- nonNestedFeatures = new ArrayList<SequenceFeature>();
- positionalFeatureGroups = new HashSet<String>();
- nonPositionalFeatureGroups = new HashSet<String>();
- positionalMinScore = Float.NaN;
- positionalMaxScore = Float.NaN;
- nonPositionalMinScore = Float.NaN;
- nonPositionalMaxScore = Float.NaN;
-
- // we only construct nonPositionalFeatures, contactFeatures
- // or the NCList if we need to
+ if (feature.isNonPositional())
+ {
+ return 0;
+ }
+ if (feature.isContactFeature())
+ {
+ return 1;
+ }
+ return 1 + feature.getEnd() - feature.getBegin();
}
/**
- * Adds one sequence feature to the store, and returns true, unless the
- * feature is already contained in the store, in which case this method
- * returns false. Containment is determined by SequenceFeature.equals()
- * comparison.
+ * Answers true if the list contains the feature, else false. This method is
+ * optimised for the condition that the list is sorted on feature start
+ * position ascending, and will give unreliable results if this does not hold.
*
+ * @param list
* @param feature
+ * @return
*/
- public boolean addFeature(SequenceFeature feature)
+ public static boolean listContains(List<SequenceFeature> list,
+ SequenceFeature feature)
{
- /*
- * keep a record of feature groups
- */
- if (!feature.isNonPositional())
+ if (list == null || feature == null)
{
- positionalFeatureGroups.add(feature.getFeatureGroup());
+ return false;
}
- boolean added = false;
-
- if (feature.isContactFeature())
- {
- added = addContactFeature(feature);
- }
- else if (feature.isNonPositional())
- {
- added = addNonPositionalFeature(feature);
- }
- else
+ /*
+ * locate the first entry in the list which does not precede the feature
+ */
+ int begin = feature.begin;
+ int pos = BinarySearcher.findFirst(list, true, Compare.GE, begin);
+ int len = list.size();
+ while (pos < len)
{
- if (!nonNestedFeatures.contains(feature))
+ SequenceFeature sf = list.get(pos);
+ if (sf.begin > begin)
{
- added = addNonNestedFeature(feature);
- if (!added)
- {
- /*
- * detected a nested feature - put it in the NCList structure
- */
- added = addNestedFeature(feature);
- }
+ return false; // no match found
}
- }
-
- if (added)
- {
- /*
- * record the total extent of positional features, to make
- * getTotalFeatureLength possible; we count the length of a
- * contact feature as 1
- */
- totalExtent += getFeatureLength(feature);
-
- /*
- * record the minimum and maximum score for positional
- * and non-positional features
- */
- float score = feature.getScore();
- if (!Float.isNaN(score))
+ if (sf.equals(feature))
{
- if (feature.isNonPositional())
- {
- nonPositionalMinScore = min(nonPositionalMinScore, score);
- nonPositionalMaxScore = max(nonPositionalMaxScore, score);
- }
- else
- {
- positionalMinScore = min(positionalMinScore, score);
- positionalMaxScore = max(positionalMaxScore, score);
- }
+ return true;
}
+ pos++;
}
-
- return added;
+ return false;
}
/**
- * Answers the 'length' of the feature, counting 0 for non-positional features
- * and 1 for contact features
+ * A helper method to return the maximum of two floats, where a non-NaN value
+ * is treated as 'greater than' a NaN value (unlike Math.max which does the
+ * opposite)
*
- * @param feature
- * @return
+ * @param f1
+ * @param f2
*/
- protected static int getFeatureLength(SequenceFeature feature)
+ protected static float max(float f1, float f2)
{
- if (feature.isNonPositional())
+ if (Float.isNaN(f1))
{
- return 0;
+ return Float.isNaN(f2) ? f1 : f2;
}
- if (feature.isContactFeature())
+ else
{
- return 1;
+ return Float.isNaN(f2) ? f1 : Math.max(f1, f2);
}
- return 1 + feature.getEnd() - feature.getBegin();
}
/**
- * Adds the feature to the list of non-positional features (with lazy
- * instantiation of the list if it is null), and returns true. If the
- * non-positional features already include the new feature (by equality test),
- * then it is not added, and this method returns false. The feature group is
- * added to the set of distinct feature groups for non-positional features.
+ * A helper method to return the minimum of two floats, where a non-NaN value
+ * is treated as 'less than' a NaN value (unlike Math.min which does the
+ * opposite)
*
- * @param feature
+ * @param f1
+ * @param f2
*/
- protected boolean addNonPositionalFeature(SequenceFeature feature)
+ protected static float min(float f1, float f2)
{
- if (nonPositionalFeatures == null)
+ if (Float.isNaN(f1))
{
- nonPositionalFeatures = new ArrayList<SequenceFeature>();
+ return Float.isNaN(f2) ? f1 : f2;
}
- if (nonPositionalFeatures.contains(feature))
+ else
{
- return false;
+ return Float.isNaN(f2) ? f1 : Math.min(f1, f2);
}
-
- nonPositionalFeatures.add(feature);
-
- nonPositionalFeatureGroups.add(feature.getFeatureGroup());
-
- return true;
}
/**
- * Adds one feature to the NCList that can manage nested features (creating
- * the NCList if necessary), and returns true. If the feature is already
- * stored in the NCList (by equality test), then it is not added, and this
- * method returns false.
+ * Constructor that defaults to using NCList IntervalStore
*/
- protected synchronized boolean addNestedFeature(SequenceFeature feature)
+ public FeatureStore()
{
- if (nestedFeatures == null)
- {
- nestedFeatures = new NCList<SequenceFeature>(feature);
- return true;
- }
- return nestedFeatures.add(feature, false);
+ this(IntervalStoreType.INTERVAL_STORE_NCLIST);
}
/**
- * Add a feature to the list of non-nested features, maintaining the ordering
- * of the list. A check is made for whether the feature is nested in (properly
- * contained by) an existing feature. If there is no nesting, the feature is
- * added to the list and the method returns true. If nesting is found, the
- * feature is not added and the method returns false.
- *
- * @param feature
- * @return
+ * Constructor that allows an alternative IntervalStore implementation to be
+ * chosen
*/
- protected boolean addNonNestedFeature(SequenceFeature feature)
+ public FeatureStore(IntervalStoreType intervalStoreType)
{
- synchronized (nonNestedFeatures)
- {
- /*
- * find the first stored feature which doesn't precede the new one
- */
- int insertPosition = binarySearch(nonNestedFeatures,
- SearchCriterion.byFeature(feature, startOrdering));
-
- /*
- * fail if we detect feature enclosure - of the new feature by
- * the one preceding it, or of the next feature by the new one
- */
- if (insertPosition > 0)
- {
- if (encloses(nonNestedFeatures.get(insertPosition - 1), feature))
- {
- return false;
- }
- }
- if (insertPosition < nonNestedFeatures.size())
- {
- if (encloses(feature, nonNestedFeatures.get(insertPosition)))
- {
- return false;
- }
- }
-
- /*
- * checks passed - add the feature
- */
- nonNestedFeatures.add(insertPosition, feature);
+ features = getIntervalStore(intervalStoreType);
+ positionalFeatureGroups = new HashSet<>();
+ nonPositionalFeatureGroups = new HashSet<>();
+ positionalMinScore = Float.NaN;
+ positionalMaxScore = Float.NaN;
+ nonPositionalMinScore = Float.NaN;
+ nonPositionalMaxScore = Float.NaN;
- return true;
- }
+ // only construct nonPositionalFeatures or contactFeatures if needed
}
/**
- * Answers true if range1 properly encloses range2, else false
+ * Returns a new instance of IntervalStoreI of implementation as selected by
+ * the type parameter
*
- * @param range1
- * @param range2
+ * @param type
* @return
*/
- protected boolean encloses(ContiguousI range1, ContiguousI range2)
+ private IntervalStoreI<SequenceFeature> getIntervalStore(
+ IntervalStoreType type)
{
- int begin1 = range1.getBegin();
- int begin2 = range2.getBegin();
- int end1 = range1.getEnd();
- int end2 = range2.getEnd();
- if (begin1 == begin2 && end1 > end2)
- {
- return true;
- }
- if (begin1 < begin2 && end1 >= end2)
+ switch (type)
{
- return true;
+ default:
+ case INTERVAL_STORE_NCLIST:
+ return new intervalstore.impl.IntervalStore<>();
+ case INTERVAL_STORE_NCARRAY:
+ return new intervalstore.nonc.IntervalStore<>();
+ case INTERVAL_STORE_LINKED_LIST:
+ return new intervalstore.nonc.IntervalStore0<>();
}
- return false;
}
/**
* Add a contact feature to the lists that hold them ordered by start (first
* contact) and by end (second contact) position, ensuring the lists remain
- * ordered, and returns true. If the contact feature lists already contain the
- * given feature (by test for equality), does not add it and returns false.
+ * ordered, and returns true. This method allows duplicate features to be
+ * added, so test before calling to avoid this.
*
* @param feature
* @return
{
if (contactFeatureStarts == null)
{
- contactFeatureStarts = new ArrayList<SequenceFeature>();
- }
- if (contactFeatureEnds == null)
- {
- contactFeatureEnds = new ArrayList<SequenceFeature>();
+ contactFeatureStarts = new ArrayList<>();
+ contactFeatureEnds = new ArrayList<>();
}
- // TODO binary search for insertion points!
- if (contactFeatureStarts.contains(feature))
- {
- return false;
- }
-
- contactFeatureStarts.add(feature);
- Collections.sort(contactFeatureStarts, startOrdering);
- contactFeatureEnds.add(feature);
- Collections.sort(contactFeatureEnds, endOrdering);
+ /*
+ * insert into list sorted by start (first contact position):
+ * binary search the sorted list to find the insertion point
+ */
+ int insertAt = BinarySearcher.findFirst(contactFeatureStarts, true,
+ Compare.GE, feature.begin);
+ contactFeatureStarts.add(insertAt, feature);
+ /*
+ * insert into list sorted by end (second contact position):
+ * binary search the sorted list to find the insertion point
+ */
+ contactFeatureEnds.add(findFirstEnd(contactFeatureEnds, feature.end),
+ feature);
return true;
}
/**
- * Returns a (possibly empty) list of features whose extent overlaps the given
- * range. The returned list is not ordered. Contact features are included if
- * either of the contact points lies within the range.
+ * Adds one sequence feature to the store, and returns true, unless the
+ * feature is already contained in the store, in which case this method
+ * returns false. Containment is determined by SequenceFeature.equals()
+ * comparison.
*
- * @param start
- * start position of overlap range (inclusive)
- * @param end
- * end position of overlap range (inclusive)
- * @return
+ * @param feature
*/
- public List<SequenceFeature> findOverlappingFeatures(long start, long end)
+ public boolean addFeature(SequenceFeature feature)
{
- List<SequenceFeature> result = new ArrayList<SequenceFeature>();
+ if (feature.isContactFeature())
+ {
+ if (containsContactFeature(feature))
+ {
+ return false;
+ }
+ positionalFeatureGroups.add(feature.getFeatureGroup());
+ if (feature.begin > maxContactStart)
+ {
+ maxContactStart = feature.begin;
+ }
+ addContactFeature(feature);
+ }
+ else if (feature.isNonPositional())
+ {
+ if (containsNonPositionalFeature(feature))
+ {
+ return false;
+ }
- findNonNestedFeatures(start, end, result);
+ addNonPositionalFeature(feature);
+ }
+ else
+ {
+ if (!features.add(feature, false))
+ {
+ return false;
+ }
+ positionalFeatureGroups.add(feature.getFeatureGroup());
+ if (feature.begin > maxStart)
+ {
+ maxStart = feature.begin;
+ }
+ }
- findContactFeatures(start, end, result);
+ /*
+ * record the total extent of positional features, to make
+ * getTotalFeatureLength possible; we count the length of a
+ * contact feature as 1
+ */
+ totalExtent += getFeatureLength(feature);
- if (nestedFeatures != null)
+ /*
+ * record the minimum and maximum score for positional
+ * and non-positional features
+ */
+ float score = feature.getScore();
+ if (!Float.isNaN(score))
{
- result.addAll(nestedFeatures.findOverlaps(start, end));
+ if (feature.isNonPositional())
+ {
+ nonPositionalMinScore = min(nonPositionalMinScore, score);
+ nonPositionalMaxScore = max(nonPositionalMaxScore, score);
+ }
+ else
+ {
+ positionalMinScore = min(positionalMinScore, score);
+ positionalMaxScore = max(positionalMaxScore, score);
+ }
}
- return result;
+ return true;
}
/**
- * Adds contact features to the result list where either the second or the
- * first contact position lies within the target range
+ * A helper method that adds to the result list any features from the
+ * collection provided whose feature group matches the specified group
*
- * @param from
- * @param to
+ * @param group
+ * @param sfs
* @param result
*/
- protected void findContactFeatures(long from, long to,
- List<SequenceFeature> result)
+ private void addFeaturesForGroup(String group,
+ Collection<SequenceFeature> sfs, List<SequenceFeature> result)
{
- if (contactFeatureStarts != null)
+ if (sfs == null)
{
- findContactStartFeatures(from, to, result);
+ return;
}
- if (contactFeatureEnds != null)
+ for (SequenceFeature sf : sfs)
{
- findContactEndFeatures(from, to, result);
+ String featureGroup = sf.getFeatureGroup();
+ if (group == null && featureGroup == null
+ || group != null && group.equals(featureGroup))
+ {
+ result.add(sf);
+ }
}
}
/**
- * Adds to the result list any contact features whose end (second contact
- * point), but not start (first contact point), lies in the query from-to
- * range
+ * Adds the feature to the list of non-positional features (with lazy
+ * instantiation of the list if it is null), and returns true. The feature
+ * group is added to the set of distinct feature groups for non-positional
+ * features. This method allows duplicate features, so test before calling to
+ * prevent this.
*
- * @param from
- * @param to
- * @param result
+ * @param feature
*/
- protected void findContactEndFeatures(long from, long to,
- List<SequenceFeature> result)
+ protected boolean addNonPositionalFeature(SequenceFeature feature)
{
- /*
- * find the first contact feature (if any) that does not lie
- * entirely before the target range
- */
- int startPosition = binarySearch(contactFeatureEnds,
- SearchCriterion.byEnd(from));
- for (; startPosition < contactFeatureEnds.size(); startPosition++)
+ if (nonPositionalFeatures == null)
{
- SequenceFeature sf = contactFeatureEnds.get(startPosition);
- if (!sf.isContactFeature())
- {
- System.err.println("Error! non-contact feature type "
- + sf.getType() + " in contact features list");
- continue;
- }
+ nonPositionalFeatures = new ArrayList<>();
+ }
- int begin = sf.getBegin();
- if (begin >= from && begin <= to)
- {
- /*
- * this feature's first contact position lies in the search range
- * so we don't include it in results a second time
- */
- continue;
- }
-
- int end = sf.getEnd();
- if (end >= from && end <= to)
- {
- result.add(sf);
- }
- if (end > to)
- {
- break;
- }
- }
- }
+ nonPositionalFeatures.add(feature);
- /**
- * Adds non-nested features to the result list that lie within the target
- * range. Non-positional features (start=end=0), contact features and nested
- * features are excluded.
- *
- * @param from
- * @param to
- * @param result
- */
- protected void findNonNestedFeatures(long from, long to,
- List<SequenceFeature> result)
- {
- int startIndex = binarySearch(nonNestedFeatures,
- SearchCriterion.byEnd(from));
+ nonPositionalFeatureGroups.add(feature.getFeatureGroup());
- findNonNestedFeatures(startIndex, from, to, result);
+ return true;
}
/**
- * Scans the list of non-nested features, starting from startIndex, to find
- * those that overlap the from-to range, and adds them to the result list.
- * Returns the index of the first feature whose start position is after the
- * target range (or the length of the whole list if none such feature exists).
+ * Answers true if this store contains the given feature (testing by
+ * SequenceFeature.equals), else false
*
- * @param startIndex
- * @param from
- * @param to
- * @param result
+ * @param feature
* @return
*/
- protected int findNonNestedFeatures(final int startIndex, long from,
- long to, List<SequenceFeature> result)
+ public boolean contains(SequenceFeature feature)
{
- int i = startIndex;
- while (i < nonNestedFeatures.size())
+ if (feature.isNonPositional())
{
- SequenceFeature sf = nonNestedFeatures.get(i);
- if (sf.getBegin() > to)
- {
- break;
- }
- int start = sf.getBegin();
- int end = sf.getEnd();
- if (start <= to && end >= from)
- {
- result.add(sf);
- }
- i++;
+ return containsNonPositionalFeature(feature);
}
- return i;
- }
-
- /**
- * Adds contact features whose start position lies in the from-to range to the
- * result list
- *
- * @param from
- * @param to
- * @param result
- */
- protected void findContactStartFeatures(long from, long to,
- List<SequenceFeature> result)
- {
- int startPosition = binarySearch(contactFeatureStarts,
- SearchCriterion.byStart(from));
- for (; startPosition < contactFeatureStarts.size(); startPosition++)
+ if (feature.isContactFeature())
{
- SequenceFeature sf = contactFeatureStarts.get(startPosition);
- if (!sf.isContactFeature())
- {
- System.err.println("Error! non-contact feature type "
- + sf.getType() + " in contact features list");
- continue;
- }
- int begin = sf.getBegin();
- if (begin >= from && begin <= to)
- {
- result.add(sf);
- }
+ return containsContactFeature(feature);
}
+
+ return containsPositionalFeature(feature);
}
- /**
- * Answers a list of all positional features stored, in no guaranteed order
- *
- * @return
- */
- public List<SequenceFeature> getPositionalFeatures()
+ private boolean containsPositionalFeature(SequenceFeature feature)
{
- /*
- * add non-nested features (may be all features for many cases)
- */
- List<SequenceFeature> result = new ArrayList<SequenceFeature>();
- result.addAll(nonNestedFeatures);
-
- /*
- * add any contact features - from the list by start position
- */
- if (contactFeatureStarts != null)
- {
- result.addAll(contactFeatureStarts);
- }
-
- /*
- * add any nested features
- */
- if (nestedFeatures != null)
- {
- result.addAll(nestedFeatures.getEntries());
- }
-
- return result;
+ return features == null || feature.begin > maxStart ? false
+ : features.contains(feature);
}
/**
- * Answers a list of all contact features. If there are none, returns an
- * immutable empty list.
+ * Answers true if this store already contains a contact feature equal to the
+ * given feature (by {@code SequenceFeature.equals()} test), else false
*
+ * @param feature
* @return
*/
- public List<SequenceFeature> getContactFeatures()
+ private boolean containsContactFeature(SequenceFeature feature)
{
- if (contactFeatureStarts == null)
- {
- return Collections.emptyList();
- }
- return new ArrayList<SequenceFeature>(contactFeatureStarts);
+ return contactFeatureStarts != null && feature.begin <= maxContactStart
+ && listContains(contactFeatureStarts, feature);
}
/**
- * Answers a list of all non-positional features. If there are none, returns
- * an immutable empty list.
+ * Answers true if this store already contains a non-positional feature equal
+ * to the given feature (by {@code SequenceFeature.equals()} test), else false
*
+ * @param feature
* @return
*/
- public List<SequenceFeature> getNonPositionalFeatures()
+ private boolean containsNonPositionalFeature(SequenceFeature feature)
{
- if (nonPositionalFeatures == null)
- {
- return Collections.emptyList();
- }
- return new ArrayList<SequenceFeature>(nonPositionalFeatures);
+ return nonPositionalFeatures == null ? false
+ : nonPositionalFeatures.contains(feature);
}
/**
*/
public synchronized boolean delete(SequenceFeature sf)
{
- /*
- * try the non-nested positional features first
- */
- boolean removed = nonNestedFeatures.remove(sf);
+ boolean removed = false;
/*
- * if not found, try contact positions (and if found, delete
+ * try contact positions (and if found, delete
* from both lists of contact positions)
*/
if (!removed && contactFeatureStarts != null)
}
}
- boolean removedNonPositional = false;
-
/*
* if not found, try non-positional features
*/
if (!removed && nonPositionalFeatures != null)
{
- removedNonPositional = nonPositionalFeatures.remove(sf);
- removed = removedNonPositional;
+ removed = nonPositionalFeatures.remove(sf);
}
/*
* if not found, try nested features
*/
- if (!removed && nestedFeatures != null)
+ if (!removed && features != null)
{
- removed = nestedFeatures.delete(sf);
+ removed = features.remove(sf);
}
if (removed)
return removed;
}
- /**
- * Rescan all features to recompute any cached values after an entry has been
- * deleted
- */
- protected synchronized void rescanAfterDelete()
+ public List<SequenceFeature> findFeatures(long start, long end)
{
- positionalFeatureGroups.clear();
- nonPositionalFeatureGroups.clear();
- totalExtent = 0;
- positionalMinScore = Float.NaN;
- positionalMaxScore = Float.NaN;
- nonPositionalMinScore = Float.NaN;
- nonPositionalMaxScore = Float.NaN;
-
- /*
- * scan non-positional features for groups and scores
- */
- for (SequenceFeature sf : getNonPositionalFeatures())
- {
- nonPositionalFeatureGroups.add(sf.getFeatureGroup());
- float score = sf.getScore();
- nonPositionalMinScore = min(nonPositionalMinScore, score);
- nonPositionalMaxScore = max(nonPositionalMaxScore, score);
- }
-
- /*
- * scan positional features for groups, scores and extents
- */
- for (SequenceFeature sf : getPositionalFeatures())
- {
- positionalFeatureGroups.add(sf.getFeatureGroup());
- float score = sf.getScore();
- positionalMinScore = min(positionalMinScore, score);
- positionalMaxScore = max(positionalMaxScore, score);
- totalExtent += getFeatureLength(sf);
- }
+ return findFeatures(start, end, null);
}
/**
- * A helper method to return the minimum of two floats, where a non-NaN value
- * is treated as 'less than' a NaN value (unlike Math.min which does the
- * opposite)
+ * Returns a (possibly empty) list of features whose extent overlaps the given
+ * range. The returned list is not ordered. Contact features are included if
+ * either of the contact points lies within the range. If the {@code result}
+ * parameter is not null, new entries are added to this list and the (possibly
+ * extended) list returned.
*
- * @param f1
- * @param f2
+ * @param start
+ * start position of overlap range (inclusive)
+ * @param end
+ * end position of overlap range (inclusive)
+ * @param result
+ * @return
*/
- protected static float min(float f1, float f2)
+ public List<SequenceFeature> findFeatures(long start, long end,
+ List<SequenceFeature> result)
{
- if (Float.isNaN(f1))
+ if (result == null)
{
- return Float.isNaN(f2) ? f1 : f2;
- }
- else
- {
- return Float.isNaN(f2) ? f1 : Math.min(f1, f2);
+ result = new ArrayList<>();
}
+
+ findContactFeatures(start, end, result);
+ features.findOverlaps(start, end, result);
+
+ return result;
}
/**
- * A helper method to return the maximum of two floats, where a non-NaN value
- * is treated as 'greater than' a NaN value (unlike Math.max which does the
- * opposite)
+ * Returns a (possibly empty) list of stored contact features
*
- * @param f1
- * @param f2
+ * @return
*/
- protected static float max(float f1, float f2)
+ public List<SequenceFeature> getContactFeatures()
{
- if (Float.isNaN(f1))
- {
- return Float.isNaN(f2) ? f1 : f2;
- }
- else
- {
- return Float.isNaN(f2) ? f1 : Math.max(f1, f2);
- }
+ List<SequenceFeature> result = new ArrayList<>();
+ getContactFeatures(result);
+ return result;
}
/**
- * Scans all positional features to check whether the given feature group is
- * found, and returns true if found, else false
+ * Adds any stored contact features to the result list
*
- * @param featureGroup
* @return
*/
- protected boolean findFeatureGroup(String featureGroup)
+ public void getContactFeatures(List<SequenceFeature> result)
{
- for (SequenceFeature sf : getPositionalFeatures())
+ if (contactFeatureStarts != null)
{
- String group = sf.getFeatureGroup();
- if (group == featureGroup
- || (group != null && group.equals(featureGroup)))
- {
- return true;
- }
+ result.addAll(contactFeatureStarts);
}
- return false;
}
/**
- * Answers true if this store has no features, else false
+ * Answers the number of positional (or non-positional) features stored.
+ * Contact features count as 1.
*
+ * @param positional
* @return
*/
- public boolean isEmpty()
+ public int getFeatureCount(boolean positional)
{
- boolean hasFeatures = !nonNestedFeatures.isEmpty()
- || (contactFeatureStarts != null && !contactFeatureStarts
- .isEmpty())
- || (nonPositionalFeatures != null && !nonPositionalFeatures
- .isEmpty())
- || (nestedFeatures != null && nestedFeatures.size() > 0);
+ if (!positional)
+ {
+ return nonPositionalFeatures == null ? 0
+ : nonPositionalFeatures.size();
+ }
- return !hasFeatures;
+ int size = 0;
+
+ if (contactFeatureStarts != null)
+ {
+ // note a contact feature (start/end) counts as one
+ size += contactFeatureStarts.size();
+ }
+
+ if (features != null)
+ {
+ size += features.size();
+ }
+ return size;
}
/**
}
else
{
- return nonPositionalFeatureGroups == null ? Collections
- .<String> emptySet() : Collections
- .unmodifiableSet(nonPositionalFeatureGroups);
+ return nonPositionalFeatureGroups == null
+ ? Collections.<String> emptySet()
+ : Collections.unmodifiableSet(nonPositionalFeatureGroups);
}
}
/**
- * Performs a binary search of the (sorted) list to find the index of the
- * first entry which returns true for the given comparator function. Returns
- * the length of the list if there is no such entry.
+ * Answers a list of all either positional or non-positional features whose
+ * feature group matches the given group (which may be null)
*
- * @param features
- * @param sc
+ * @param positional
+ * @param group
* @return
*/
- protected int binarySearch(List<SequenceFeature> features,
- SearchCriterion sc)
+ public List<SequenceFeature> getFeaturesForGroup(boolean positional,
+ String group)
{
- int start = 0;
- int end = features.size() - 1;
- int matched = features.size();
+ List<SequenceFeature> result = new ArrayList<>();
- while (start <= end)
+ /*
+ * if we know features don't include the target group, no need
+ * to inspect them for matches
+ */
+ if (positional && !positionalFeatureGroups.contains(group)
+ || !positional && !nonPositionalFeatureGroups.contains(group))
{
- int mid = (start + end) / 2;
- SequenceFeature entry = features.get(mid);
- boolean compare = sc.compare(entry);
- if (compare)
- {
- matched = mid;
- end = mid - 1;
- }
- else
- {
- start = mid + 1;
- }
+ return result;
}
- return matched;
+ if (positional)
+ {
+ addFeaturesForGroup(group, contactFeatureStarts, result);
+ addFeaturesForGroup(group, features, result);
+ }
+ else
+ {
+ addFeaturesForGroup(group, nonPositionalFeatures, result);
+ }
+ return result;
}
/**
- * Answers the number of positional (or non-positional) features stored.
- * Contact features count as 1.
+ * Answers the maximum score held for positional or non-positional features.
+ * This may be Float.NaN if there are no features, are none has a non-NaN
+ * score.
*
* @param positional
* @return
*/
- public int getFeatureCount(boolean positional)
+ public float getMaximumScore(boolean positional)
{
- if (!positional)
+ return positional ? positionalMaxScore : nonPositionalMaxScore;
+ }
+
+ /**
+ * Answers the minimum score held for positional or non-positional features.
+ * This may be Float.NaN if there are no features, are none has a non-NaN
+ * score.
+ *
+ * @param positional
+ * @return
+ */
+ public float getMinimumScore(boolean positional)
+ {
+ return positional ? positionalMinScore : nonPositionalMinScore;
+ }
+
+ /**
+ * Answers a (possibly empty) list of all non-positional features
+ *
+ * @return
+ */
+ public List<SequenceFeature> getNonPositionalFeatures()
+ {
+ List<SequenceFeature> result = new ArrayList<>();
+ getNonPositionalFeatures(result);
+ return result;
+ }
+
+ /**
+ * Adds any stored non-positional features to the result list
+ *
+ * @return
+ */
+ public void getNonPositionalFeatures(List<SequenceFeature> result)
+ {
+ if (nonPositionalFeatures != null)
{
- return nonPositionalFeatures == null ? 0 : nonPositionalFeatures
- .size();
+ result.addAll(nonPositionalFeatures);
}
+ }
- int size = nonNestedFeatures.size();
+ /**
+ * Returns a (possibly empty) list of all positional features stored
+ *
+ * @return
+ */
+ public List<SequenceFeature> getPositionalFeatures()
+ {
+ List<SequenceFeature> result = new ArrayList<>();
+ getPositionalFeatures(result);
+
+ return result;
+ }
+ /**
+ * Adds all positional features stored to the result list, in no guaranteed
+ * order, and with no check for duplicates
+ */
+ public void getPositionalFeatures(List<SequenceFeature> result)
+ {
+ /*
+ * add any contact features - from the list by start position
+ */
if (contactFeatureStarts != null)
{
- // note a contact feature (start/end) counts as one
- size += contactFeatureStarts.size();
+ result.addAll(contactFeatureStarts);
}
- if (nestedFeatures != null)
+ /*
+ * add any nested features
+ */
+ if (features != null)
{
- size += nestedFeatures.size();
+ result.addAll(features);
}
-
- return size;
}
/**
}
/**
- * Answers the minimum score held for positional or non-positional features.
- * This may be Float.NaN if there are no features, are none has a non-NaN
- * score.
+ * Answers true if this store has no features, else false
*
- * @param positional
* @return
*/
- public float getMinimumScore(boolean positional)
+ public boolean isEmpty()
{
- return positional ? positionalMinScore : nonPositionalMinScore;
+ boolean hasFeatures = (contactFeatureStarts != null
+ && !contactFeatureStarts.isEmpty())
+ || (nonPositionalFeatures != null
+ && !nonPositionalFeatures.isEmpty())
+ || (features != null && features.size() > 0);
+
+ return !hasFeatures;
}
/**
- * Answers the maximum score held for positional or non-positional features.
- * This may be Float.NaN if there are no features, are none has a non-NaN
- * score.
+ * Rescan all features to recompute any cached values after an entry has been
+ * deleted. This is expected to be an infrequent event, so performance here is
+ * not critical.
+ */
+ protected synchronized void rescanAfterDelete()
+ {
+ positionalFeatureGroups.clear();
+ nonPositionalFeatureGroups.clear();
+ totalExtent = 0;
+ positionalMinScore = Float.NaN;
+ positionalMaxScore = Float.NaN;
+ nonPositionalMinScore = Float.NaN;
+ nonPositionalMaxScore = Float.NaN;
+ /*
+ * scan non-positional features for groups and scores
+ */
+ if (nonPositionalFeatures != null)
+ {
+ for (int i = 0, n = nonPositionalFeatures.size(); i < n; i++)
+ {
+ SequenceFeature sf = nonPositionalFeatures.get(i);
+ nonPositionalFeatureGroups.add(sf.getFeatureGroup());
+ float score = sf.getScore();
+ nonPositionalMinScore = min(nonPositionalMinScore, score);
+ nonPositionalMaxScore = max(nonPositionalMaxScore, score);
+ }
+ }
+
+ rescanPositional(contactFeatureStarts);
+ rescanPositional(features);
+ }
+
+ /**
+ * Scans the given features and updates cached feature groups, minimum and
+ * maximum feature score, and total feature extent (length) for positional
+ * features
*
- * @param positional
+ * @param sfs
+ */
+ private void rescanPositional(Collection<SequenceFeature> sfs)
+ {
+ if (sfs == null)
+ {
+ return;
+ }
+ for (SequenceFeature sf : sfs)
+ {
+ positionalFeatureGroups.add(sf.getFeatureGroup());
+ float score = sf.getScore();
+ positionalMinScore = min(positionalMinScore, score);
+ positionalMaxScore = max(positionalMaxScore, score);
+ totalExtent += getFeatureLength(sf);
+ }
+ }
+
+ /**
+ * Adds the shift amount to the start and end of all positional features whose
+ * start position is at or after fromPosition. Returns true if at least one
+ * feature was shifted, else false.
+ *
+ * @param fromPosition
+ * @param shiftBy
* @return
*/
- public float getMaximumScore(boolean positional)
+ public synchronized boolean shiftFeatures(int fromPosition, int shiftBy)
{
- return positional ? positionalMaxScore : nonPositionalMaxScore;
+ /*
+ * Because begin and end are final fields (to ensure the data store's
+ * integrity), we have to delete each feature and re-add it as amended.
+ * (Although a simple shift of all values would preserve data integrity!)
+ */
+ boolean modified = false;
+ List<SequenceFeature> list = getPositionalFeatures();
+ for (int i = 0, n = list.size(); i < n; i++)
+ {
+ SequenceFeature sf = list.get(i);
+ if (sf.getBegin() >= fromPosition)
+ {
+ modified = true;
+ int newBegin = sf.getBegin() + shiftBy;
+ int newEnd = sf.getEnd() + shiftBy;
+
+ /*
+ * sanity check: don't shift left of the first residue
+ */
+ if (newEnd > 0)
+ {
+ newBegin = Math.max(1, newBegin);
+ SequenceFeature sf2 = new SequenceFeature(sf, newBegin, newEnd,
+ sf.getFeatureGroup(), sf.getScore());
+ addFeature(sf2);
+ }
+ delete(sf);
+ }
+ }
+ return modified;
}
+
+ /**
+ * Answers the position (0, 1...) in the list of the first entry whose end
+ * position is not less than {@ pos}. If no such entry is found, answers the
+ * length of the list.
+ *
+ * @param list
+ * @param pos
+ * @return
+ */
+ protected int findFirstEnd(List<SequenceFeature> list, long pos)
+ {
+ return BinarySearcher.findFirst(list, false, Compare.GE, (int) pos);
+ }
+
+ /**
+ * Adds contact features to the result list where either the second or the
+ * first contact position lies within the target range
+ *
+ * @param from
+ * @param to
+ * @param result
+ */
+ protected void findContactFeatures(long from, long to,
+ List<SequenceFeature> result)
+ {
+ if (contactFeatureStarts != null)
+ {
+ findContactStartOverlaps(from, to, result);
+ findContactEndOverlaps(from, to, result);
+ }
+ }
+
+ /**
+ * Adds to the result list any contact features whose end (second contact
+ * point), but not start (first contact point), lies in the query from-to
+ * range
+ *
+ * @param from
+ * @param to
+ * @param result
+ */
+ private void findContactEndOverlaps(long from, long to,
+ List<SequenceFeature> result)
+ {
+ /*
+ * find the first contact feature (if any)
+ * whose end point is not before the target range
+ */
+ int index = findFirstEnd(contactFeatureEnds, from);
+
+ int n = contactFeatureEnds.size();
+ while (index < n)
+ {
+ SequenceFeature sf = contactFeatureEnds.get(index);
+ if (!sf.isContactFeature())
+ {
+ System.err.println("Error! non-contact feature type " + sf.getType()
+ + " in contact features list");
+ index++;
+ continue;
+ }
+
+ int begin = sf.getBegin();
+ if (begin >= from && begin <= to)
+ {
+ /*
+ * this feature's first contact position lies in the search range
+ * so we don't include it in results a second time
+ */
+ index++;
+ continue;
+ }
+
+ if (sf.getEnd() > to)
+ {
+ /*
+ * this feature (and all following) has end point after the target range
+ */
+ break;
+ }
+
+ /*
+ * feature has end >= from and end <= to
+ * i.e. contact end point lies within overlap search range
+ */
+ result.add(sf);
+ index++;
+ }
+ }
+
+ /**
+ * Adds contact features whose start position lies in the from-to range to the
+ * result list
+ *
+ * @param from
+ * @param to
+ * @param result
+ */
+ private void findContactStartOverlaps(long from, long to,
+ List<SequenceFeature> result)
+ {
+ int index = BinarySearcher.findFirst(contactFeatureStarts, true,
+ Compare.GE, (int) from);
+
+ while (index < contactFeatureStarts.size())
+ {
+ SequenceFeature sf = contactFeatureStarts.get(index);
+ if (!sf.isContactFeature())
+ {
+ System.err.println("Error! non-contact feature " + sf.toString()
+ + " in contact features list");
+ index++;
+ continue;
+ }
+ if (sf.getBegin() > to)
+ {
+ /*
+ * this feature's start (and all following) follows the target range
+ */
+ break;
+ }
+
+ /*
+ * feature has begin >= from and begin <= to
+ * i.e. contact start point lies within overlap search range
+ */
+ result.add(sf);
+ index++;
+ }
+ }
+
}
git://source.jalview.org / jalview.git / blobdiff