com.gengoai.apollo.ml.encoder.FixedEncoder 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.encoder;

import com.gengoai.apollo.ml.observation.Observation;
import com.gengoai.collection.HashMapIndex;
import com.gengoai.collection.Index;
import com.gengoai.stream.MStream;
import lombok.NonNull;

import java.util.Collection;
import java.util.Collections;
import java.util.Set;

/**
 * Implementation of a {@link Encoder} for a Fixed vocabulary.
 *
 * @author David B. Bracewell
 */
public class FixedEncoder implements Encoder {
   private static final long serialVersionUID = 1L;
   private final Index alphabet = new HashMapIndex<>();

   /**
    * Instantiates a new FixedEncoder.
    *
    * @param alphabet the alphabet
    */
   public FixedEncoder(@NonNull Collection alphabet) {
      this.alphabet.addAll(alphabet);
   }

   @Override
   public String decode(double index) {
      return alphabet.get((int) index);
   }

   @Override
   public int encode(String variableName) {
      return alphabet.getId(variableName);
   }

   @Override
   public void fit(@NonNull MStream stream) {
   }

   @Override
   public Set getAlphabet() {
      return Collections.unmodifiableSet(alphabet.itemSet());
   }

   @Override
   public boolean isFixed() {
      return true;
   }

   @Override
   public int size() {
      return alphabet.size();
   }
}//END OF FixedEncoder