package iterator import ( "fmt" "strings" "github.com/google/cayley/graph" ) // Not iterator acts like a complement for the primary iterator. // It will return all the vertices which are not part of the primary iterator. type Not struct { uid uint64 tags graph.Tagger primaryIt graph.Iterator allIt graph.Iterator result graph.Value runstats graph.IteratorStats } func NewNot(primaryIt, allIt graph.Iterator) *Not { return &Not{ uid: NextUID(), primaryIt: primaryIt, allIt: allIt, } } func (it *Not) UID() uint64 { return it.uid } // Reset resets the internal iterators and the iterator itself. func (it *Not) Reset() { it.result = nil it.primaryIt.Reset() it.allIt.Reset() } func (it *Not) Tagger() *graph.Tagger { return &it.tags } func (it *Not) TagResults(dst map[string]graph.Value) { for _, tag := range it.tags.Tags() { dst[tag] = it.Result() } for tag, value := range it.tags.Fixed() { dst[tag] = value } if it.primaryIt != nil { it.primaryIt.TagResults(dst) } } func (it *Not) Clone() graph.Iterator { not := NewNot(it.primaryIt.Clone(), it.allIt.Clone()) not.tags.CopyFrom(it) return not } // SubIterators returns a slice of the sub iterators. // The first iterator is the primary iterator, for which the complement // is generated. func (it *Not) SubIterators() []graph.Iterator { return []graph.Iterator{it.primaryIt, it.allIt} } // DEPRECATED func (it *Not) ResultTree() *graph.ResultTree { tree := graph.NewResultTree(it.Result()) tree.AddSubtree(it.primaryIt.ResultTree()) tree.AddSubtree(it.allIt.ResultTree()) return tree } // DebugString prints information about the iterator. func (it *Not) DebugString(indent int) string { var tags string for _, k := range it.tags.Tags() { tags += fmt.Sprintf("%s;", k) } spaces := strings.Repeat(" ", indent+2) return fmt.Sprintf("%s(%s %d\n%stags:%v\n%sprimary_it:\n%s\n)", strings.Repeat(" ", indent), it.Type(), it.UID(), spaces, it.tags.Tags(), spaces, it.primaryIt.DebugString(indent+4), ) } // Next advances the Not iterator. It returns whether there is another valid // new value. It fetches the next value of the all iterator which is not // contained by the primary iterator. func (it *Not) Next() bool { graph.NextLogIn(it) it.runstats.Next += 1 for graph.Next(it.allIt) { if curr := it.allIt.Result(); !it.primaryIt.Contains(curr) { it.result = curr it.runstats.ContainsNext += 1 return graph.NextLogOut(it, curr, true) } } return graph.NextLogOut(it, nil, false) } func (it *Not) Result() graph.Value { return it.result } // Contains checks whether the passed value is part of the primary iterator's // complement. For a valid value, it updates the Result returned by the iterator // to the value itself. func (it *Not) Contains(val graph.Value) bool { graph.ContainsLogIn(it, val) it.runstats.Contains += 1 if it.primaryIt.Contains(val) { return graph.ContainsLogOut(it, val, false) } it.result = val return graph.ContainsLogOut(it, val, true) } // NextPath checks whether there is another path. Not applicable, hence it will // return false. func (it *Not) NextPath() bool { return false } func (it *Not) Close() { it.primaryIt.Close() it.allIt.Close() } func (it *Not) Type() graph.Type { return graph.Not } func (it *Not) Optimize() (graph.Iterator, bool) { // TODO - consider wrapping the primaryIt with a MaterializeIt if optimizedPrimaryIt, optimized := it.primaryIt.Optimize(); optimized { it.primaryIt = optimizedPrimaryIt return it, true } return it, false } func (it *Not) Stats() graph.IteratorStats { subitStats := it.primaryIt.Stats() // TODO(barakmich): These should really come from the triplestore itself fanoutFactor := int64(20) checkConstant := int64(1) nextConstant := int64(2) return graph.IteratorStats{ NextCost: nextConstant + subitStats.NextCost, ContainsCost: checkConstant + subitStats.ContainsCost, Size: fanoutFactor * subitStats.Size, Next: it.runstats.Next, Contains: it.runstats.Contains, ContainsNext: it.runstats.ContainsNext, } } func (it *Not) Size() (int64, bool) { return it.Stats().Size, false }