com.gengoai.apollo.ml.observation.VariableSequence Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apollo Show documentation
There is a newer version: 2.1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.gengoai.apollo.ml.observation;

import com.fasterxml.jackson.annotation.*;
import lombok.NonNull;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.stream.Stream;

/**
 * 
 * A {@link Sequence} where the observations are {@link Variable}s. This implementation works well for raw sequence
 * input or sequence label output, but care must * be taken when filtering Variables as null values will replace the
 * filtered values.
 * 
 *
 * @author David B. Bracewell
 */
@JsonTypeName("vs")
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
@JsonAutoDetect(
      fieldVisibility = JsonAutoDetect.Visibility.NONE,
      setterVisibility = JsonAutoDetect.Visibility.NONE,
      getterVisibility = JsonAutoDetect.Visibility.NONE,
      isGetterVisibility = JsonAutoDetect.Visibility.NONE,
      creatorVisibility = JsonAutoDetect.Visibility.NONE
)
public class VariableSequence extends ArrayList implements Sequence {
   /**
    * Instantiates a new VariableSequence
    */
   public VariableSequence() {
   }

   /**
    * Instantiates a new VariableSequence.
    *
    * @param collection the Collection of variables
    */
   @JsonCreator
   public VariableSequence(@JsonProperty("seq") @NonNull Collection collection) {
      super(collection);
   }

   /**
    * Instantiates a new VariableSequence.
    *
    * @param stream the stream of variables
    */
   public VariableSequence(@NonNull Stream stream) {
      stream.forEach(this::add);
   }

   @Override
   public VariableSequence copy() {
      return new VariableSequence(stream().map(Variable::copy));
   }

   @JsonProperty("seq")
   private List getSequence() {
      return this;
   }

   @Override
   public void mapVariables(@NonNull Function mapper) {
      for(int i = 0; i < size(); i++) {
         set(i, mapper.apply(get(i)));
      }
   }

   @Override
   public void removeVariables(@NonNull Predicate filter) {
      for(int i = 0; i < size(); i++) {
         if(filter.test(get(i))) {
            set(i, null);
         }
      }
   }

   @Override
   public void updateVariables(@NonNull Consumer updater) {
      forEach(updater);
   }

}//END OF VariableSequence